Address SpotBugs warnings about confused inheritance

eregon · eregon · commit d26c7e19f63d · 2023-07-08T12:38:56.000+02:00
diff --git a/src/main/java/org/truffleruby/cext/ValueWrapperManager.java b/src/main/java/org/truffleruby/cext/ValueWrapperManager.java
@@ -280,8 +280,8 @@ public static final class ValueWrapperWeakReference extends WeakReference<ValueW
     }
 
     public static final class HandleBlockHolder {
-        protected HandleBlock handleBlock = null;
-        protected HandleBlock sharedHandleBlock = null;
+        private HandleBlock handleBlock = null;
+        private HandleBlock sharedHandleBlock = null;
     }
 
     @GenerateUncached
diff --git a/src/main/java/org/truffleruby/core/MarkingService.java b/src/main/java/org/truffleruby/core/MarkingService.java
@@ -41,19 +41,19 @@ public static interface MarkerAction {
 
     protected static final class ExtensionCallStackEntry {
 
-        protected final ExtensionCallStackEntry previous;
-        protected ValueWrapper preservedObject;
-        protected ArrayList<ValueWrapper> preservedObjects;
-        protected final boolean keywordsGiven;
-        protected Object specialVariables;
-        protected final Object block;
-        protected CapturedException capturedException;
-        protected ValueWrapper markOnExitObject;
-        protected ArrayList<ValueWrapper> markOnExitObjects;
-        protected Object[] marks;
-        protected int marksIndex = 0;
-
-        protected ExtensionCallStackEntry(
+        private final ExtensionCallStackEntry previous;
+        ValueWrapper preservedObject;
+        ArrayList<ValueWrapper> preservedObjects;
+        private final boolean keywordsGiven;
+        private Object specialVariables;
+        private final Object block;
+        private CapturedException capturedException;
+        private ValueWrapper markOnExitObject;
+        private ArrayList<ValueWrapper> markOnExitObjects;
+        private Object[] marks;
+        private int marksIndex = 0;
+
+        private ExtensionCallStackEntry(
                 ExtensionCallStackEntry previous,
                 boolean keywordsGiven,
                 Object specialVariables,
@@ -68,7 +68,7 @@ protected ExtensionCallStackEntry(
 
     public static final class ExtensionCallStack {
 
-        protected ExtensionCallStackEntry current;
+        ExtensionCallStackEntry current;
 
         public ExtensionCallStack(Object specialVariables, Object block) {
             current = new ExtensionCallStackEntry(null, false, specialVariables, block);
diff --git a/src/main/java/org/truffleruby/core/array/ArrayBuilderNode.java b/src/main/java/org/truffleruby/core/array/ArrayBuilderNode.java
@@ -35,9 +35,9 @@
 public abstract class ArrayBuilderNode extends RubyBaseNode {
 
     public static final class BuilderState {
-        protected int capacity;
-        protected int nextIndex = 0;
-        protected Object store;
+        private int capacity;
+        private int nextIndex = 0;
+        Object store;
 
         private BuilderState(Object store, int capacity) {
             this.capacity = capacity;
diff --git a/src/main/java/org/truffleruby/interop/ProxyForeignObject.java b/src/main/java/org/truffleruby/interop/ProxyForeignObject.java
@@ -26,8 +26,8 @@
 @ExportLibrary(ReflectionLibrary.class)
 public final class ProxyForeignObject implements TruffleObject {
 
-    protected final Object delegate;
-    protected final Object logger;
+    final Object delegate;
+    private final Object logger;
 
     private static final Message EXECUTABLE = Message.resolve(InteropLibrary.class, "execute");
     private static final Message INVOKE = Message.resolve(InteropLibrary.class, "invokeMember");
diff --git a/src/main/java/org/truffleruby/language/arguments/SplatToArgsNode.java b/src/main/java/org/truffleruby/language/arguments/SplatToArgsNode.java
@@ -18,7 +18,7 @@
 
 public final class SplatToArgsNode extends RubyBaseNode {
 
-    @Child protected ArrayStoreLibrary stores;
+    @Child ArrayStoreLibrary stores;
     final IntValueProfile splatSizeProfile = IntValueProfile.create();
 
     public SplatToArgsNode(RubyLanguage language) {
diff --git a/src/main/java/org/truffleruby/language/control/RaiseException.java b/src/main/java/org/truffleruby/language/control/RaiseException.java
@@ -22,7 +22,7 @@
 @ExportLibrary(value = InteropLibrary.class, delegateTo = "exception")
 public final class RaiseException extends AbstractTruffleException implements RubyThrowable {
 
-    protected final RubyException exception;
+    final RubyException exception;
 
     public RaiseException(RubyContext context, RubyException exception) {
         this(context, exception, null);
diff --git a/src/main/java/org/truffleruby/language/globals/ReadMatchReferenceNodes.java b/src/main/java/org/truffleruby/language/globals/ReadMatchReferenceNodes.java
@@ -28,7 +28,7 @@ public static final class ReadNthMatchNode extends RubyContextSourceNode {
         @Child private DispatchNode getIndexNode;
         private final int index;
 
-        protected final ConditionProfile matchNilProfile = ConditionProfile.create();
+        private final ConditionProfile matchNilProfile = ConditionProfile.create();
 
         public ReadNthMatchNode(RubyNode readMatchNode, int index) {
             this.readMatchNode = readMatchNode;
@@ -79,7 +79,7 @@ public static final class SetNamedVariablesMatchNode extends RubyContextSourceNo
         @Children private final RubyNode[] setters;
         @Children private final RubyNode[] nilSetters;
 
-        protected final ConditionProfile matchNilProfile = ConditionProfile.create();
+        private final ConditionProfile matchNilProfile = ConditionProfile.create();
 
         public SetNamedVariablesMatchNode(
                 RubyNode matchDataNode,
diff --git a/src/main/java/org/truffleruby/language/objects/DefineClassNode.java b/src/main/java/org/truffleruby/language/objects/DefineClassNode.java
@@ -24,7 +24,7 @@
 
 public final class DefineClassNode extends RubyContextSourceNode {
 
-    protected final String name;
+    private final String name;
 
     @Child private RubyNode superClassNode;
     @Child private RubyNode lexicalParentModule;
diff --git a/src/main/java/org/truffleruby/parser/TranslatorEnvironment.java b/src/main/java/org/truffleruby/parser/TranslatorEnvironment.java
@@ -57,7 +57,7 @@ public final class TranslatorEnvironment {
     private final boolean ownScopeForAssignments;
     private final boolean isModuleBody;
 
-    protected final TranslatorEnvironment parent;
+    private final TranslatorEnvironment parent;
     private final SharedMethodInfo sharedMethodInfo;
 
     public final String modulePath;
diff --git a/src/main/java/org/truffleruby/parser/ast/ArgsParseNode.java b/src/main/java/org/truffleruby/parser/ast/ArgsParseNode.java
@@ -62,7 +62,7 @@ public final class ArgsParseNode extends ParseNode {
      * SyntaxError would have resulted. Can change as numbered parameters are encountered. */
     private boolean isNumbered = false;
 
-    protected final ArgumentParseNode restArgNode;
+    private final ArgumentParseNode restArgNode;
     private final KeywordRestArgParseNode keyRest;
     private final BlockArgParseNode blockArgNode;
 
diff --git a/src/main/java/org/truffleruby/parser/ast/AttrAssignParseNode.java b/src/main/java/org/truffleruby/parser/ast/AttrAssignParseNode.java
@@ -36,7 +36,7 @@
 
 /** ParseNode that represents an assignment of either an array element or attribute. */
 public final class AttrAssignParseNode extends ParseNode implements INameNode, IArgumentNode {
-    protected final ParseNode receiverNode;
+    private final ParseNode receiverNode;
     private String name;
     private ParseNode argsNode;
     private final boolean isLazy;
diff --git a/src/main/java/org/truffleruby/parser/ast/CallParseNode.java b/src/main/java/org/truffleruby/parser/ast/CallParseNode.java
@@ -42,7 +42,7 @@
 public final class CallParseNode extends ParseNode implements INameNode, IArgumentNode, BlockAcceptingParseNode {
     private final ParseNode receiverNode;
     private ParseNode argsNode;
-    protected ParseNode iterNode;
+    private ParseNode iterNode;
     private String name;
     private final boolean isLazy;
 
diff --git a/src/main/java/org/truffleruby/parser/ast/FCallParseNode.java b/src/main/java/org/truffleruby/parser/ast/FCallParseNode.java
@@ -41,8 +41,8 @@
 /** Represents a method call with self as an implicit receiver. */
 public final class FCallParseNode extends ParseNode implements INameNode, IArgumentNode, BlockAcceptingParseNode {
     private String name;
-    protected ParseNode argsNode;
-    protected ParseNode iterNode;
+    private ParseNode argsNode;
+    private ParseNode iterNode;
 
     public FCallParseNode(SourceIndexLength position, String name) {
         this(position, name, null, null);
diff --git a/src/main/java/org/truffleruby/parser/ast/InParseNode.java b/src/main/java/org/truffleruby/parser/ast/InParseNode.java
@@ -47,8 +47,8 @@
 
 /** Represents an in condition */
 public final class InParseNode extends ParseNode {
-    protected final ParseNode expressionNodes;
-    protected final ParseNode bodyNode;
+    private final ParseNode expressionNodes;
+    private final ParseNode bodyNode;
     private final ParseNode nextCase;
 
     public InParseNode(
diff --git a/src/main/java/org/truffleruby/parser/ast/SValueParseNode.java b/src/main/java/org/truffleruby/parser/ast/SValueParseNode.java
@@ -35,7 +35,7 @@
 import org.truffleruby.parser.ast.visitor.NodeVisitor;
 
 public final class SValueParseNode extends ParseNode {
-    protected final ParseNode node;
+    private final ParseNode node;
 
     public SValueParseNode(SourceIndexLength position, ParseNode node) {
         super(position);
diff --git a/src/main/java/org/truffleruby/parser/ast/SplatParseNode.java b/src/main/java/org/truffleruby/parser/ast/SplatParseNode.java
@@ -35,7 +35,7 @@
 import org.truffleruby.parser.ast.visitor.NodeVisitor;
 
 public final class SplatParseNode extends ParseNode {
-    protected final ParseNode node;
+    private final ParseNode node;
 
     public SplatParseNode(SourceIndexLength position, ParseNode node) {
         super(position);
diff --git a/src/main/java/org/truffleruby/parser/lexer/RubyLexer.java b/src/main/java/org/truffleruby/parser/lexer/RubyLexer.java
@@ -2882,20 +2882,20 @@ private int scanHex(int count, boolean strict, String errorMessage) {
     /** Was end-of-file reached? (or {@link #END_MARKER}) */
     public boolean eofp = false;
 
-    protected int parenNest = 0;
-    protected int braceNest = 0;
+    private int parenNest = 0;
+    private int braceNest = 0;
     public boolean commandStart;
-    protected StackState conditionState = new StackState();
-    protected StackState cmdArgumentState = new StackState();
+    private StackState conditionState = new StackState();
+    private StackState cmdArgumentState = new StackState();
     private TruffleString current_arg;
     public boolean inKwarg = false;
-    protected int last_cr_line;
+    private int last_cr_line;
     private int leftParenBegin = 0;
 
     // -- END FIELDS ---
 
     // MRI: comment_at_top
-    protected boolean comment_at_top() {
+    private boolean comment_at_top() {
         int p = lex_pbeg;
         int pend = lex_p - 1;
         if (line_count != (has_shebang ? 2 : 1)) {
diff --git a/src/main/java/org/truffleruby/parser/parser/ParserSupport.java b/src/main/java/org/truffleruby/parser/parser/ParserSupport.java
@@ -186,9 +186,9 @@ public final class ParserSupport {
     public static final String UNDERSCORE_PREFIX = "_$";
 
     // Parser states:
-    protected StaticScope currentScope;
+    private StaticScope currentScope;
 
-    protected RubyLexer lexer;
+    private RubyLexer lexer;
 
     // Is the parser current within a singleton (value is number of nested singletons)
     private int inSingleton;
@@ -199,7 +199,7 @@ public final class ParserSupport {
     // Is the parser currently within a class body.
     private boolean inClass;
 
-    protected ParserConfiguration configuration;
+    private ParserConfiguration configuration;
     private RubyParserResult result;
 
     private final String file;
diff --git a/src/main/java/org/truffleruby/parser/parser/RubyParser.java b/src/main/java/org/truffleruby/parser/parser/RubyParser.java
diff --git a/src/main/java/org/truffleruby/parser/parser/RubyParser.y b/src/main/java/org/truffleruby/parser/parser/RubyParser.y
@@ -118,9 +118,9 @@ import static org.truffleruby.parser.parser.ParserSupport.value_expr;
 // CheckStyle: start generated
 @SuppressFBWarnings("IP")
 @SuppressWarnings({"unchecked", "fallthrough", "cast"})
-public class RubyParser {
-    protected final ParserSupport support;
-    protected final RubyLexer lexer;
+public final class RubyParser {
+    private final ParserSupport support;
+    private final RubyLexer lexer;
 
     public RubyParser(LexerSource source, RubyDeferredWarnings warnings) {
         this.support = new ParserSupport(source, warnings);
diff --git a/src/main/java/org/truffleruby/parser/parser/skeleton.parser b/src/main/java/org/truffleruby/parser/parser/skeleton.parser
diff --git a/src/main/java/org/truffleruby/parser/scope/StaticScope.java b/src/main/java/org/truffleruby/parser/scope/StaticScope.java
diff --git a/tool/patch_parser.rb b/tool/patch_parser.rb
diff --git a/tool/post-process-parser.rb b/tool/post-process-parser.rb

Original file line number	Diff line number	Diff line change
`@@ -280,8 +280,8 @@ public static final class ValueWrapperWeakReference extends WeakReference<ValueW`
`280`	`280`	`}`
`281`	`281`
`282`	`282`	`public static final class HandleBlockHolder {`
`283`		`- protected HandleBlock handleBlock = null;`
`284`		`- protected HandleBlock sharedHandleBlock = null;`
	`283`	`+ private HandleBlock handleBlock = null;`
	`284`	`+ private HandleBlock sharedHandleBlock = null;`
`285`	`285`	`}`
`286`	`286`
`287`	`287`	`@GenerateUncached`