1 /*
 2  * Copyright (c) 2013, 2025, 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.comp;
27 
28 import java.util.HashMap;
29 
30 import com.sun.tools.javac.util.Context;
31 
32 /** Partial map to record which compiler phases have been executed
33  *  for each compilation unit. Used for ATTR and FLOW phases.
34  *
35  *  <p><b>This is NOT part of any supported API.
36  *  If you write code that depends on this, you do so at your own risk.
37  *  This code and its internal interfaces are subject to change or
38  *  deletion without notice.</b>
39  */
40 public class CompileStates extends HashMap<Env<AttrContext>, CompileStates.CompileState> {
41     /** The context key for the compile states. */
42     protected static final Context.Key<CompileStates> compileStatesKey = new Context.Key<>();
43 
44     /** Get the CompileStates instance for this context. */
45     public static CompileStates instance(Context context) {
46         CompileStates instance = context.get(compileStatesKey);
47         if (instance == null) {
48             instance = new CompileStates(context);
49         }
50         return instance;
51     }
52 
53     /** Ordered list of compiler phases for each compilation unit. */
54     public enum CompileState {
55         INIT(0),
56         PARSE(1),
57         ENTER(2),
58         PROCESS(3),
59         ATTR(4),
60         FLOW(5),
61         WARN(6),
62         TRANSTYPES(7),
63         TRANSPATTERNS(8),
64         LOWER(9),
65         UNLAMBDA(10),
66         STRICT_FIELDS_PROXIES(11),
67         GENERATE(12);
68 
69         CompileState(int value) {
70             this.value = value;
71         }
72         public boolean isAfter(CompileState other) {
73             return value > other.value;
74         }
75         public static CompileState max(CompileState a, CompileState b) {
76             return a.value > b.value ? a : b;
77         }
78         private final int value;
79     }
80 
81     private static final long serialVersionUID = 1812267524140424433L;
82 
83     protected transient Context context;
84 
85     @SuppressWarnings("this-escape")
86     public CompileStates(Context context) {
87         this.context = context;
88         context.put(compileStatesKey, this);
89     }
90 
91     public boolean isDone(Env<AttrContext> env, CompileState cs) {
92         CompileState ecs = get(env);
93         return (ecs != null) && !cs.isAfter(ecs);
94     }
95 }