Replace defines with an enum per table

This is more precise, shows up errors (e.g. trying to read whether a
class is protected, when no such concept exists in Java, and doesn't run
the risk of different tables using different bit flags for the same
concept.

Author: thk123

jbmc/src/java_bytecode/java_bytecode_parser.cpp

@@ -444,28 +444,37 @@ bool java_bytecode_parsert::parse()
   return false;
 }
 
-#define ACC_PUBLIC       0x0001
-#define ACC_PRIVATE      0x0002
-#define ACC_PROTECTED    0x0004
-#define ACC_STATIC       0x0008
-#define ACC_FINAL        0x0010
-#define ACC_SYNCHRONIZED 0x0020
-#define ACC_BRIDGE       0x0040
-#define ACC_VARARGS      0x0080
-#define ACC_NATIVE       0x0100
-#define ACC_INTERFACE    0x0200
-#define ACC_ABSTRACT     0x0400
-#define ACC_STRICT       0x0800
-#define ACC_SYNTHETIC    0x1000
-#define ACC_ANNOTATION   0x2000
-#define ACC_ENUM         0x4000
-
 #ifdef _MSC_VER
 #define UNUSED
 #else
 #define UNUSED __attribute__((unused))
 #endif
 
+/// Represents the bit flag from class access and property flags
+/// https://docs.oracle.com/javase/specs/jvms/se8/html/jvms-4.html#jvms-4.1-200-E.1
+namespace class_access_flagst
+{
+enum class_access_flagst
+{
+  /// Declared public; may be accessed from outside its package.
+  PUBLIC = 0x0001,
+  /// Declared final; no subclasses allowed.
+  FINAL = 0x0010,
+  /// Treat superclass methods specially when invoked by the invokespecial instruction.
+  SUPER = 0x0020,
+  /// Is an interface, not a class.
+  INTERFACE = 0x0200,
+  /// Declared abstract; must not be instantiated.
+  ABSTRACT = 0x0400,
+  /// Declared synthetic; not present in the source code.
+  SYNTHETIC = 0x1000,
+  /// Declared as an annotation type.
+  ANNOTATION = 0x2000,
+  /// Declared as an enum type.
+  ENUM = 0x4000,
+};
+}
+
 void java_bytecode_parsert::rClassFile()
 {
   parse_tree.loading_successful=false;
@@ -494,15 +503,17 @@ void java_bytecode_parsert::rClassFile()
   u2 this_class=read_u2();
   u2 super_class=read_u2();
 
-  parsed_class.is_abstract=(access_flags&ACC_ABSTRACT)!=0;
-  parsed_class.is_enum=(access_flags&ACC_ENUM)!=0;
-  parsed_class.is_public=(access_flags&ACC_PUBLIC)!=0;
-  parsed_class.is_protected=(access_flags&ACC_PROTECTED)!=0;
-  parsed_class.is_private=(access_flags&ACC_PRIVATE)!=0;
-  parsed_class.is_final = (access_flags & ACC_FINAL) != 0;
-  parsed_class.is_interface = (access_flags & ACC_INTERFACE) != 0;
-  parsed_class.is_synthetic = (access_flags & ACC_SYNTHETIC) != 0;
-  parsed_class.is_annotation = (access_flags & ACC_ANNOTATION) != 0;
+  parsed_class.is_abstract =
+    (access_flags & class_access_flagst::ABSTRACT) != 0;
+  parsed_class.is_enum = (access_flags & class_access_flagst::ENUM) != 0;
+  parsed_class.is_public = (access_flags & class_access_flagst::PUBLIC) != 0;
+  parsed_class.is_final = (access_flags & class_access_flagst::FINAL) != 0;
+  parsed_class.is_interface =
+    (access_flags & class_access_flagst::INTERFACE) != 0;
+  parsed_class.is_synthetic =
+    (access_flags & class_access_flagst::SYNTHETIC) != 0;
+  parsed_class.is_annotation =
+    (access_flags & class_access_flagst::ANNOTATION) != 0;
   parsed_class.name=
     constant(this_class).type().get(ID_C_base_name);
 
@@ -870,6 +881,33 @@ void java_bytecode_parsert::rinterfaces(classt &parsed_class)
       .push_back(constant(read_u2()).type().get(ID_C_base_name));
 }
 
+/// Represents the bit flag from field access and property flags
+/// https://docs.oracle.com/javase/specs/jvms/se8/html/jvms-4.html#jvms-4.5-200-A.1
+namespace field_access_flagst
+{
+enum field_access_flagst
+{
+  /// Declared public; may be accessed from outside its package.
+  PUBLIC = 0x0001,
+  /// Declared private; usable only within the defining class.
+  PRIVATE = 0x0002,
+  /// Declared protected; may be accessed within subclasses.
+  PROTECTED = 0x0004,
+  /// Declared static.
+  STATIC = 0x0008,
+  /// Declared final; never directly assigned to after object construction (JLS §17.5).
+  FINAL = 0x0010,
+  /// Declared volatile; cannot be cached.
+  VOLATILE = 0x0040,
+  /// Declared transient; not written or read by a persistent object manager.
+  TRANSIENT = 0x0080,
+  /// Declared synthetic; not present in the source code.
+  SYNTHETIC = 0x1000,
+  /// Declared as an element of an enum.
+  ENUM = 0x4000
+};
+}
+
 void java_bytecode_parsert::rfields(classt &parsed_class)
 {
   u2 fields_count=read_u2();
@@ -884,14 +922,14 @@ void java_bytecode_parsert::rfields(classt &parsed_class)
     u2 attributes_count=read_u2();
 
     field.name=pool_entry(name_index).s;
-    field.is_static=(access_flags&ACC_STATIC)!=0;
-    field.is_final=(access_flags&ACC_FINAL)!=0;
-    field.is_enum=(access_flags&ACC_ENUM)!=0;
+    field.is_static = (access_flags & field_access_flagst::STATIC) != 0;
+    field.is_final = (access_flags & field_access_flagst::FINAL) != 0;
+    field.is_enum = (access_flags & field_access_flagst::ENUM) != 0;
 
     field.descriptor=id2string(pool_entry(descriptor_index).s);
-    field.is_public=(access_flags&ACC_PUBLIC)!=0;
-    field.is_protected=(access_flags&ACC_PROTECTED)!=0;
-    field.is_private=(access_flags&ACC_PRIVATE)!=0;
+    field.is_public = (access_flags & field_access_flagst::PUBLIC) != 0;
+    field.is_protected = (access_flags & field_access_flagst::PROTECTED) != 0;
+    field.is_private = (access_flags & field_access_flagst::PRIVATE) != 0;
     const auto flags = (field.is_public ? 1 : 0) +
       (field.is_protected?1:0)+
       (field.is_private?1:0);
@@ -1578,6 +1616,35 @@ void java_bytecode_parsert::relement_value_pair(
   }
 }
 
+/// Represents the bit flag from inner class access and property flags
+/// https://docs.oracle.com/javase/specs/jvms/se8/html/jvms-4.html#jvms-4.7.6-300-D.1-D.1
+namespace inner_class_access_flagst
+{
+enum inner_class_access_flagst
+{
+  /// Marked or implicitly public in source.
+  PUBLIC = 0x0001,
+  /// Marked private in source.
+  PRIVATE = 0x0002,
+  /// Marked protected in source.
+  PROTECTED = 0x0004,
+  /// Marked or implicitly static in source.
+  STATIC = 0x0008,
+  /// Marked final in source.
+  FINAL = 0x0010,
+  /// Was an interface in source.
+  INTERFACE = 0x0200,
+  /// Marked or implicitly abstract in source.
+  ABSTRACT = 0x0400,
+  /// Declared synthetic; not present in the source code.
+  SYNTHETIC = 0x1000,
+  /// Declared as an annotation type.
+  ANNOTATION = 0x2000,
+  /// Declared as an enum type.
+  ENUM = 0x4000,
+};
+}
+
 /// Corresponds to the element_value structure
 /// Described in Java 8 specification 4.7.6
 /// https://docs.oracle.com/javase/specs/jvms/se8/html/jvms-4.html#jvms-4.7.6
@@ -1619,10 +1686,14 @@ void java_bytecode_parsert::rinner_classes_attribute(
     std::string inner_class_info_name =
       class_infot(pool_entry(inner_class_info_index))
         .get_name(pool_entry_lambda);
-    bool is_private = (inner_class_access_flags & ACC_PRIVATE) != 0;
-    bool is_public = (inner_class_access_flags & ACC_PUBLIC) != 0;
-    bool is_protected = (inner_class_access_flags & ACC_PROTECTED) != 0;
-    bool is_static = (inner_class_access_flags & ACC_STATIC) != 0;
+    bool is_private =
+      (inner_class_access_flags & inner_class_access_flagst::PRIVATE) != 0;
+    bool is_public =
+      (inner_class_access_flags & inner_class_access_flagst::PUBLIC) != 0;
+    bool is_protected =
+      (inner_class_access_flags & inner_class_access_flagst::PROTECTED) != 0;
+    bool is_static =
+      (inner_class_access_flags & inner_class_access_flagst::STATIC) != 0;
 
     // If the original parsed class name matches the inner class name,
     // the parsed class is an inner class, so overwrite the parsed class'
@@ -1735,19 +1806,38 @@ void java_bytecode_parsert::rmethods(classt &parsed_class)
     rmethod(parsed_class);
 }
 
-#define ACC_PUBLIC     0x0001
-#define ACC_PRIVATE    0x0002
-#define ACC_PROTECTED  0x0004
-#define ACC_STATIC     0x0008
-#define ACC_FINAL      0x0010
-#define ACC_SUPER      0x0020
-#define ACC_VOLATILE   0x0040
-#define ACC_TRANSIENT  0x0080
-#define ACC_INTERFACE  0x0200
-#define ACC_ABSTRACT   0x0400
-#define ACC_SYNTHETIC  0x1000
-#define ACC_ANNOTATION 0x2000
-#define ACC_ENUM       0x4000
+/// Represents the bit flag from Method access and property flags
+/// https://docs.oracle.com/javase/specs/jvms/se8/html/jvms-4.html#jvms-4.6-200-A.1
+namespace method_access_flagst
+{
+enum method_access_flagst
+{
+  /// Declared public; may be accessed from outside its package.
+  PUBLIC = 0x0001,
+  /// Declared private; accessible only within the defining class.
+  PRIVATE = 0x0002,
+  /// Declared protected; may be accessed within subclasses.
+  PROTECTED = 0x0004,
+  /// Declared static.
+  STATIC = 0x0008,
+  /// Declared final; must not be overridden (§5.4.5).
+  FINAL = 0x0010,
+  /// Declared synchronized; invocation is wrapped by a monitor use.
+  SYNCHRONIZED = 0x0020,
+  /// A bridge method, generated by the compiler.
+  BRIDGE = 0x0040,
+  /// Declared with variable number of arguments.
+  VARARGS = 0x0080,
+  /// Declared native; implemented in a language other than Java.
+  NATIVE = 0x0100,
+  /// Declared abstract; no implementation is provided.
+  ABSTRACT = 0x0400,
+  /// Declared strictfp; floating-point mode is FP-strict.
+  STRICT = 0x0800,
+  /// Declared synthetic; not present in the source code.
+  SYNTHETIC = 0x1000
+};
+}
 
 void java_bytecode_parsert::rmethod(classt &parsed_class)
 {
@@ -1757,14 +1847,15 @@ void java_bytecode_parsert::rmethod(classt &parsed_class)
   u2 name_index=read_u2();
   u2 descriptor_index=read_u2();
 
-  method.is_final=(access_flags&ACC_FINAL)!=0;
-  method.is_static=(access_flags&ACC_STATIC)!=0;
-  method.is_abstract=(access_flags&ACC_ABSTRACT)!=0;
-  method.is_public=(access_flags&ACC_PUBLIC)!=0;
-  method.is_protected=(access_flags&ACC_PROTECTED)!=0;
-  method.is_private=(access_flags&ACC_PRIVATE)!=0;
-  method.is_synchronized=(access_flags&ACC_SYNCHRONIZED)!=0;
-  method.is_native=(access_flags&ACC_NATIVE)!=0;
+  method.is_final = (access_flags & method_access_flagst::FINAL) != 0;
+  method.is_static = (access_flags & method_access_flagst::STATIC) != 0;
+  method.is_abstract = (access_flags & method_access_flagst::ABSTRACT) != 0;
+  method.is_public = (access_flags & method_access_flagst::PUBLIC) != 0;
+  method.is_protected = (access_flags & method_access_flagst::PROTECTED) != 0;
+  method.is_private = (access_flags & method_access_flagst::PRIVATE) != 0;
+  method.is_synchronized =
+    (access_flags & method_access_flagst::SYNCHRONIZED) != 0;
+  method.is_native = (access_flags & method_access_flagst::NATIVE) != 0;
   method.name=pool_entry(name_index).s;
   method.base_name=pool_entry(name_index).s;
   method.descriptor=id2string(pool_entry(descriptor_index).s);