1 /*
  2  * Copyright (c) 2002, 2022, Oracle and/or its affiliates. All rights reserved.
  3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  4  *
  5  * This code is free software; you can redistribute it and/or modify it
  6  * under the terms of the GNU General Public License version 2 only, as
  7  * published by the Free Software Foundation.  Oracle designates this
  8  * particular file as subject to the "Classpath" exception as provided
  9  * by Oracle in the LICENSE file that accompanied this code.
 10  *
 11  * This code is distributed in the hope that it will be useful, but WITHOUT
 12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 14  * version 2 for more details (a copy is included in the LICENSE file that
 15  * accompanied this code).
 16  *
 17  * You should have received a copy of the GNU General Public License version
 18  * 2 along with this work; if not, write to the Free Software Foundation,
 19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 20  *
 21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 22  * or visit www.oracle.com if you need additional information or have any
 23  * questions.
 24  */
 25 
 26 package com.sun.tools.javac.code;
 27 
 28 import java.util.*;
 29 
 30 import javax.lang.model.SourceVersion;
 31 import static javax.lang.model.SourceVersion.*;
 32 
 33 import com.sun.tools.javac.jvm.Target;
 34 import com.sun.tools.javac.resources.CompilerProperties.Errors;
 35 import com.sun.tools.javac.resources.CompilerProperties.Fragments;
 36 import com.sun.tools.javac.util.*;
 37 import com.sun.tools.javac.util.JCDiagnostic.Error;
 38 import com.sun.tools.javac.util.JCDiagnostic.Fragment;
 39 
 40 import static com.sun.tools.javac.main.Option.*;
 41 
 42 /** The source language version accepted.
 43  *
 44  *  <p><b>This is NOT part of any supported API.
 45  *  If you write code that depends on this, you do so at your own risk.
 46  *  This code and its internal interfaces are subject to change or
 47  *  deletion without notice.</b>
 48  */
 49 public enum Source {
 50     /** 1.0 had no inner classes, and so could not pass the JCK. */
 51     // public static final Source JDK1_0 =              new Source("1.0");
 52 
 53     /** 1.1 did not have strictfp, and so could not pass the JCK. */
 54     // public static final Source JDK1_1 =              new Source("1.1");
 55 
 56     /** 1.2 introduced strictfp. */
 57     JDK1_2("1.2"),
 58 
 59     /** 1.3 is the same language as 1.2. */
 60     JDK1_3("1.3"),
 61 
 62     /** 1.4 introduced assert. */
 63     JDK1_4("1.4"),
 64 
 65     /** 1.5 introduced generics, attributes, foreach, boxing, static import,
 66      *  covariant return, enums, varargs, et al. */
 67     JDK5("5"),
 68 
 69     /** 1.6 reports encoding problems as errors instead of warnings. */
 70     JDK6("6"),
 71 
 72     /** 1.7 introduced try-with-resources, multi-catch, string switch, etc. */
 73     JDK7("7"),
 74 
 75     /** 1.8 lambda expressions and default methods. */
 76     JDK8("8"),
 77 
 78     /** 1.9 modularity. */
 79     JDK9("9"),
 80 
 81     /** 1.10 local-variable type inference (var). */
 82     JDK10("10"),
 83 
 84     /** 1.11 local-variable syntax for lambda parameters */
 85     JDK11("11"),
 86 
 87     /** 12, no language features; switch expression in preview */
 88     JDK12("12"),
 89 
 90     /**
 91      * 13, no language features; text blocks and revised switch
 92      * expressions in preview
 93      */
 94     JDK13("13"),
 95 
 96     /**
 97      * 14, switch expressions; pattern matching, records, and revised
 98      * text blocks in preview
 99      */
100     JDK14("14"),
101 
102     /**
103       * 15, text blocks
104       */
105     JDK15("15"),
106 
107     /**
108       * 16, tbd
109       */
110     JDK16("16"),
111 
112     /**
113       * 17, tbd
114       */
115     JDK17("17"),
116 
117     /**
118       * 18, tbd
119       */
120     JDK18("18"),
121 
122     /**
123       * 19, tbd
124       */
125     JDK19("19"),
126 
127     /**
128       * 20, tbd
129       */
130     JDK20("20");
131 
132     private static final Context.Key<Source> sourceKey = new Context.Key<>();
133 
134     public static Source instance(Context context) {
135         Source instance = context.get(sourceKey);
136         if (instance == null) {
137             Options options = Options.instance(context);
138             String sourceString = options.get(SOURCE);
139             if (sourceString != null) instance = lookup(sourceString);
140             if (instance == null) instance = DEFAULT;
141             context.put(sourceKey, instance);
142         }
143         return instance;
144     }
145 
146     public final String name;
147 
148     private static final Map<String,Source> tab = new HashMap<>();
149     static {
150         for (Source s : values()) {
151             tab.put(s.name, s);
152         }
153         tab.put("1.5", JDK5); // Make 5 an alias for 1.5
154         tab.put("1.6", JDK6); // Make 6 an alias for 1.6
155         tab.put("1.7", JDK7); // Make 7 an alias for 1.7
156         tab.put("1.8", JDK8); // Make 8 an alias for 1.8
157         tab.put("1.9", JDK9); // Make 9 an alias for 1.9
158         tab.put("1.10", JDK10); // Make 10 an alias for 1.10
159         // Decline to make 1.11 an alias for 11.
160     }
161 
162     private Source(String name) {
163         this.name = name;
164     }
165 
166     public static final Source MIN = Source.JDK8;
167 
168     private static final Source MAX = values()[values().length - 1];
169 
170     public static final Source DEFAULT = MAX;
171 
172     public static Source lookup(String name) {
173         return tab.get(name);
174     }
175 
176     public boolean isSupported() {
177         return this.compareTo(MIN) >= 0;
178     }
179 
180     public Target requiredTarget() {
181         return switch(this) {
182         case JDK20  -> Target.JDK1_20;
183         case JDK19  -> Target.JDK1_19;
184         case JDK18  -> Target.JDK1_18;
185         case JDK17  -> Target.JDK1_17;
186         case JDK16  -> Target.JDK1_16;
187         case JDK15  -> Target.JDK1_15;
188         case JDK14  -> Target.JDK1_14;
189         case JDK13  -> Target.JDK1_13;
190         case JDK12  -> Target.JDK1_12;
191         case JDK11  -> Target.JDK1_11;
192         case JDK10  -> Target.JDK1_10;
193         case JDK9   -> Target.JDK1_9;
194         case JDK8   -> Target.JDK1_8;
195         case JDK7   -> Target.JDK1_7;
196         case JDK6   -> Target.JDK1_6;
197         case JDK5   -> Target.JDK1_5;
198         case JDK1_4 -> Target.JDK1_4;
199         default     -> Target.JDK1_1;
200         };
201     }
202 
203     /**
204      * Models a feature of the Java programming language. Each feature can be associated with a
205      * minimum source level, a maximum source level and a diagnostic fragment describing the feature,
206      * which is used to generate error messages of the kind {@code feature XYZ not supported in source N}.
207      */
208     public enum Feature {
209 
210         MODULES(JDK9, Fragments.FeatureModules, DiagKind.PLURAL),
211         EFFECTIVELY_FINAL_VARIABLES_IN_TRY_WITH_RESOURCES(JDK9, Fragments.FeatureVarInTryWithResources, DiagKind.PLURAL),
212         DEPRECATION_ON_IMPORT(MIN, JDK8),
213         PRIVATE_SAFE_VARARGS(JDK9),
214         DIAMOND_WITH_ANONYMOUS_CLASS_CREATION(JDK9, Fragments.FeatureDiamondAndAnonClass, DiagKind.NORMAL),
215         UNDERSCORE_IDENTIFIER(MIN, JDK8),
216         PRIVATE_INTERFACE_METHODS(JDK9, Fragments.FeaturePrivateIntfMethods, DiagKind.PLURAL),
217         LOCAL_VARIABLE_TYPE_INFERENCE(JDK10),
218         VAR_SYNTAX_IMPLICIT_LAMBDAS(JDK11, Fragments.FeatureVarSyntaxInImplicitLambda, DiagKind.PLURAL),
219         IMPORT_ON_DEMAND_OBSERVABLE_PACKAGES(JDK1_2, JDK8),
220         SWITCH_MULTIPLE_CASE_LABELS(JDK14, Fragments.FeatureMultipleCaseLabels, DiagKind.PLURAL),
221         SWITCH_RULE(JDK14, Fragments.FeatureSwitchRules, DiagKind.PLURAL),
222         SWITCH_EXPRESSION(JDK14, Fragments.FeatureSwitchExpressions, DiagKind.PLURAL),
223         TEXT_BLOCKS(JDK15, Fragments.FeatureTextBlocks, DiagKind.PLURAL),
224         PATTERN_MATCHING_IN_INSTANCEOF(JDK16, Fragments.FeaturePatternMatchingInstanceof, DiagKind.NORMAL),
225         REIFIABLE_TYPES_INSTANCEOF(JDK16, Fragments.FeatureReifiableTypesInstanceof, DiagKind.PLURAL),
226         RECORDS(JDK16, Fragments.FeatureRecords, DiagKind.PLURAL),
227         SEALED_CLASSES(JDK17, Fragments.FeatureSealedClasses, DiagKind.PLURAL),
228         CASE_NULL(JDK17, Fragments.FeatureCaseNull, DiagKind.NORMAL),
229         PATTERN_SWITCH(JDK17, Fragments.FeaturePatternSwitch, DiagKind.PLURAL),
230         REDUNDANT_STRICTFP(JDK17),
231         UNCONDITIONAL_PATTERN_IN_INSTANCEOF(JDK19, Fragments.FeatureUnconditionalPatternsInInstanceof, DiagKind.PLURAL),
232         RECORD_PATTERNS(JDK19, Fragments.FeatureDeconstructionPatterns, DiagKind.PLURAL),
233         PRIMITIVE_CLASSES(JDK19, Fragments.FeaturePrimitiveClasses, DiagKind.PLURAL),
234         VALUE_CLASSES(JDK19, Fragments.FeatureValueClasses, DiagKind.PLURAL),
235         ;
236 
237         enum DiagKind {
238             NORMAL,
239             PLURAL;
240         }
241 
242         private final Source minLevel;
243         private final Source maxLevel;
244         private final Fragment optFragment;
245         private final DiagKind optKind;
246 
247         Feature(Source minLevel) {
248             this(minLevel, null, null);
249         }
250 
251         Feature(Source minLevel, Fragment optFragment, DiagKind optKind) {
252             this(minLevel, MAX, optFragment, optKind);
253         }
254 
255         Feature(Source minLevel, Source maxLevel) {
256             this(minLevel, maxLevel, null, null);
257         }
258 
259         Feature(Source minLevel, Source maxLevel, Fragment optFragment, DiagKind optKind) {
260             this.minLevel = minLevel;
261             this.maxLevel = maxLevel;
262             this.optFragment = optFragment;
263             this.optKind = optKind;
264         }
265 
266         public boolean allowedInSource(Source source) {
267             return source.compareTo(minLevel) >= 0 &&
268                     source.compareTo(maxLevel) <= 0;
269         }
270 
271         public boolean isPlural() {
272             Assert.checkNonNull(optKind);
273             return optKind == DiagKind.PLURAL;
274         }
275 
276         public Fragment nameFragment() {
277             Assert.checkNonNull(optFragment);
278             return optFragment;
279         }
280 
281         public Fragment fragment(String sourceName) {
282             Assert.checkNonNull(optFragment);
283             return optKind == DiagKind.NORMAL ?
284                     Fragments.FeatureNotSupportedInSource(optFragment, sourceName, minLevel.name) :
285                     Fragments.FeatureNotSupportedInSourcePlural(optFragment, sourceName, minLevel.name);
286         }
287 
288         public Error error(String sourceName) {
289             Assert.checkNonNull(optFragment);
290             if (this == PRIMITIVE_CLASSES) {
291                 return Errors.PrimitiveClassesNotSupported(minLevel.name);
292             }
293             return optKind == DiagKind.NORMAL ?
294                     Errors.FeatureNotSupportedInSource(optFragment, sourceName, minLevel.name) :
295                     Errors.FeatureNotSupportedInSourcePlural(optFragment, sourceName, minLevel.name);
296         }
297     }
298 
299     public static SourceVersion toSourceVersion(Source source) {
300         return switch(source) {
301         case JDK1_2 -> RELEASE_2;
302         case JDK1_3 -> RELEASE_3;
303         case JDK1_4 -> RELEASE_4;
304         case JDK5   -> RELEASE_5;
305         case JDK6   -> RELEASE_6;
306         case JDK7   -> RELEASE_7;
307         case JDK8   -> RELEASE_8;
308         case JDK9   -> RELEASE_9;
309         case JDK10  -> RELEASE_10;
310         case JDK11  -> RELEASE_11;
311         case JDK12  -> RELEASE_12;
312         case JDK13  -> RELEASE_13;
313         case JDK14  -> RELEASE_14;
314         case JDK15  -> RELEASE_15;
315         case JDK16  -> RELEASE_16;
316         case JDK17  -> RELEASE_17;
317         case JDK18  -> RELEASE_18;
318         case JDK19  -> RELEASE_19;
319         case JDK20  -> RELEASE_20;
320         default     -> null;
321         };
322     }
323 }