1 /*
2 * Copyright (c) 1997, 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.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25 #ifndef SHARE_UTILITIES_ACCESSFLAGS_HPP
26 #define SHARE_UTILITIES_ACCESSFLAGS_HPP
27
28 #include "jvm_constants.h"
29 #include "utilities/debug.hpp"
30 #include "utilities/globalDefinitions.hpp"
31 #include "utilities/macros.hpp"
32
33 // AccessFlags is an abstraction over Java ACC flags.
34 // See generated file classfile_constants.h for shared JVM_ACC_XXX access flags
35
36 class outputStream;
37
38 class AccessFlags {
39 friend class VMStructs;
40 private:
41 u2 _flags;
42
43 public:
44 AccessFlags() : _flags(0) {}
45 explicit AccessFlags(u2 flags) : _flags(flags) {}
46
47 // Java access flags
48 bool is_public () const { return (_flags & JVM_ACC_PUBLIC ) != 0; }
49 bool is_private () const { return (_flags & JVM_ACC_PRIVATE ) != 0; }
50 bool is_protected () const { return (_flags & JVM_ACC_PROTECTED ) != 0; }
51 bool is_static () const { return (_flags & JVM_ACC_STATIC ) != 0; }
52 bool is_final () const { return (_flags & JVM_ACC_FINAL ) != 0; }
53 bool is_synchronized() const { return (_flags & JVM_ACC_SYNCHRONIZED) != 0; }
54 bool is_super () const { return (_flags & JVM_ACC_SUPER ) != 0; }
55 bool is_volatile () const { return (_flags & JVM_ACC_VOLATILE ) != 0; }
56 bool is_transient () const { return (_flags & JVM_ACC_TRANSIENT ) != 0; }
57 bool is_native () const { return (_flags & JVM_ACC_NATIVE ) != 0; }
58 bool is_interface () const { return (_flags & JVM_ACC_INTERFACE ) != 0; }
59 bool is_abstract () const { return (_flags & JVM_ACC_ABSTRACT ) != 0; }
60
61 // Attribute flags
62 bool is_synthetic () const { return (_flags & JVM_ACC_SYNTHETIC ) != 0; }
63
64 // get as integral value
65 u2 as_unsigned_short() const { return _flags; }
66
67 void set_flags(u2 flags) { _flags = flags; }
68
69 private:
70 friend class Klass;
71 friend class ClassFileParser;
72 // the functions below should only be called on the _access_flags inst var directly,
73 // otherwise they are just changing a copy of the flags
74
75 // attribute flags
76 void set_is_synthetic() { _flags |= JVM_ACC_SYNTHETIC; }
77
78 public:
79 inline friend AccessFlags accessFlags_from(u2 flags);
80
81 u2 as_method_flags() const {
82 assert((_flags & JVM_RECOGNIZED_METHOD_MODIFIERS) == _flags, "only recognized flags");
83 return _flags;
84 }
85
86 u2 as_field_flags() const {
87 assert((_flags & JVM_RECOGNIZED_FIELD_MODIFIERS) == _flags, "only recognized flags");
88 return _flags;
89 }
90
91 u2 as_class_flags() const {
92 assert((_flags & JVM_RECOGNIZED_CLASS_MODIFIERS) == _flags, "only recognized flags");
93 return _flags;
94 }
95
96 // Printing/debugging
97 #if INCLUDE_JVMTI
98 void print_on(outputStream* st) const;
99 #else
100 void print_on(outputStream* st) const PRODUCT_RETURN;
101 #endif
102 };
103
104 inline AccessFlags accessFlags_from(u2 flags) {
105 AccessFlags af;
106 af._flags = flags;
107 return af;
108 }
109
110 #endif // SHARE_UTILITIES_ACCESSFLAGS_HPP