refactor: LineRange to record to fix immutability

pmbittner · pmbittner · commit a378493eb12f · 2023-04-14T13:36:16.000+02:00
diff --git a/src/main/java/org/variantsync/diffdetective/preliminary/pattern/elementary/FeatureContextOfAddToPC.java b/src/main/java/org/variantsync/diffdetective/preliminary/pattern/elementary/FeatureContextOfAddToPC.java
@@ -24,7 +24,7 @@ public PatternMatch<DiffNode> createMatch(DiffNode codeNode) {
         final LineRange diffLines = codeNode.getLinesInDiff();
 
         return new PatternMatch<>(this,
-                diffLines.getFromInclusive(), diffLines.getToExclusive(), fm
+                diffLines.fromInclusive(), diffLines.toExclusive(), fm
         );
     }
 
diff --git a/src/main/java/org/variantsync/diffdetective/preliminary/pattern/elementary/FeatureContextOfAddWithMapping.java b/src/main/java/org/variantsync/diffdetective/preliminary/pattern/elementary/FeatureContextOfAddWithMapping.java
@@ -24,8 +24,8 @@ public PatternMatch<DiffNode> createMatch(DiffNode codeNode) {
         final LineRange diffLines = codeNode.getLinesInDiff();
 
         return new PatternMatch<>(this,
-                diffLines.getFromInclusive(),
-                diffLines.getToExclusive(), fm
+                diffLines.fromInclusive(),
+                diffLines.toExclusive(), fm
         );
     }
 
diff --git a/src/main/java/org/variantsync/diffdetective/preliminary/pattern/elementary/FeatureContextOfGeneralization.java b/src/main/java/org/variantsync/diffdetective/preliminary/pattern/elementary/FeatureContextOfGeneralization.java
@@ -19,7 +19,7 @@ public Pattern<DiffNode> getPattern() {
     public PatternMatch<DiffNode> createMatch(DiffNode codeNode) {
         final LineRange diffLines = codeNode.getLinesInDiff();
         return new PatternMatch<>(this,
-                diffLines.getFromInclusive(), diffLines.getToExclusive()
+                diffLines.fromInclusive(), diffLines.toExclusive()
         );
     }
 
diff --git a/src/main/java/org/variantsync/diffdetective/preliminary/pattern/elementary/FeatureContextOfReconfiguration.java b/src/main/java/org/variantsync/diffdetective/preliminary/pattern/elementary/FeatureContextOfReconfiguration.java
@@ -19,7 +19,7 @@ public Pattern<DiffNode> getPattern() {
     public PatternMatch<DiffNode> createMatch(DiffNode codeNode) {
         final LineRange diffLines = codeNode.getLinesInDiff();
         return new PatternMatch<>(this,
-                diffLines.getFromInclusive(), diffLines.getToExclusive()
+                diffLines.fromInclusive(), diffLines.toExclusive()
         );
     }
 
diff --git a/src/main/java/org/variantsync/diffdetective/preliminary/pattern/elementary/FeatureContextOfRefactoring.java b/src/main/java/org/variantsync/diffdetective/preliminary/pattern/elementary/FeatureContextOfRefactoring.java
@@ -19,7 +19,7 @@ public Pattern<DiffNode> getPattern() {
     public PatternMatch<DiffNode> createMatch(DiffNode codeNode) {
         final LineRange diffLines = codeNode.getLinesInDiff();
         return new PatternMatch<>(this,
-                diffLines.getFromInclusive(), diffLines.getToExclusive()
+                diffLines.fromInclusive(), diffLines.toExclusive()
         );
     }
 
diff --git a/src/main/java/org/variantsync/diffdetective/preliminary/pattern/elementary/FeatureContextOfRemFromPC.java b/src/main/java/org/variantsync/diffdetective/preliminary/pattern/elementary/FeatureContextOfRemFromPC.java
@@ -24,7 +24,7 @@ public PatternMatch<DiffNode> createMatch(DiffNode codeNode) {
         final LineRange diffLines = codeNode.getLinesInDiff();
 
         return new PatternMatch<>(this,
-                diffLines.getFromInclusive(), diffLines.getToExclusive(), fm
+                diffLines.fromInclusive(), diffLines.toExclusive(), fm
         );
     }
 
diff --git a/src/main/java/org/variantsync/diffdetective/preliminary/pattern/elementary/FeatureContextOfRemWithMapping.java b/src/main/java/org/variantsync/diffdetective/preliminary/pattern/elementary/FeatureContextOfRemWithMapping.java
@@ -24,7 +24,7 @@ public PatternMatch<DiffNode> createMatch(DiffNode codeNode) {
         final LineRange diffLines = codeNode.getLinesInDiff();
 
         return new PatternMatch<>(this,
-                diffLines.getFromInclusive(), diffLines.getToExclusive(), fm
+                diffLines.fromInclusive(), diffLines.toExclusive(), fm
         );
     }
 
diff --git a/src/main/java/org/variantsync/diffdetective/preliminary/pattern/elementary/FeatureContextOfSpecialization.java b/src/main/java/org/variantsync/diffdetective/preliminary/pattern/elementary/FeatureContextOfSpecialization.java
@@ -19,7 +19,7 @@ public Pattern<DiffNode> getPattern() {
     public PatternMatch<DiffNode> createMatch(DiffNode codeNode) {
         final LineRange diffLines = codeNode.getLinesInDiff();
         return new PatternMatch<>(this,
-                diffLines.getFromInclusive(), diffLines.getToExclusive()
+                diffLines.fromInclusive(), diffLines.toExclusive()
         );
     }
 
diff --git a/src/main/java/org/variantsync/diffdetective/preliminary/pattern/elementary/FeatureContextOfUntouched.java b/src/main/java/org/variantsync/diffdetective/preliminary/pattern/elementary/FeatureContextOfUntouched.java
@@ -19,7 +19,7 @@ public Pattern<DiffNode> getPattern() {
     public PatternMatch<DiffNode> createMatch(DiffNode codeNode) {
         final LineRange diffLines = codeNode.getLinesInDiff();
         return new PatternMatch<>(this,
-                diffLines.getFromInclusive(), diffLines.getToExclusive()
+                diffLines.fromInclusive(), diffLines.toExclusive()
         );
     }
 
diff --git a/src/main/java/org/variantsync/diffdetective/preliminary/pattern/semantic/AddIfdefElif.java b/src/main/java/org/variantsync/diffdetective/preliminary/pattern/semantic/AddIfdefElif.java
@@ -49,7 +49,7 @@ public Optional<PatternMatch<DiffNode>> match(DiffNode annotationNode) {
 
             final LineRange diffLines = annotationNode.getLinesInDiff();
             return Optional.of(new PatternMatch<>(this,
-                    diffLines.getFromInclusive(), diffLines.getToExclusive(),
+                    diffLines.fromInclusive(), diffLines.toExclusive(),
                     mappings.toArray(new Node[0])
             ));
         }
diff --git a/src/main/java/org/variantsync/diffdetective/preliminary/pattern/semantic/AddIfdefElse.java b/src/main/java/org/variantsync/diffdetective/preliminary/pattern/semantic/AddIfdefElse.java
@@ -56,7 +56,7 @@ public Optional<PatternMatch<DiffNode>> match(DiffNode annotationNode) {
             }
 
             return Optional.of(new PatternMatch<>(this,
-                    annotationNode.getLinesInDiff().getFromInclusive(), elseNode.getLinesInDiff().getToExclusive(),
+                    annotationNode.getLinesInDiff().fromInclusive(), elseNode.getLinesInDiff().toExclusive(),
                     annotationNode.getFeatureMapping(AFTER)
             ));
         }
diff --git a/src/main/java/org/variantsync/diffdetective/preliminary/pattern/semantic/AddIfdefWrapElse.java b/src/main/java/org/variantsync/diffdetective/preliminary/pattern/semantic/AddIfdefWrapElse.java
@@ -55,7 +55,7 @@ public Optional<PatternMatch<DiffNode>> match(DiffNode annotationNode) {
             }
 
             return Optional.of(new PatternMatch<>(this,
-                    annotationNode.getLinesInDiff().getFromInclusive(), elseNode.getLinesInDiff().getToExclusive(),
+                    annotationNode.getLinesInDiff().fromInclusive(), elseNode.getLinesInDiff().toExclusive(),
                     annotationNode.getFeatureMapping(AFTER)
             ));
         }
diff --git a/src/main/java/org/variantsync/diffdetective/preliminary/pattern/semantic/AddIfdefWrapThen.java b/src/main/java/org/variantsync/diffdetective/preliminary/pattern/semantic/AddIfdefWrapThen.java
@@ -56,7 +56,7 @@ public Optional<PatternMatch<DiffNode>> match(DiffNode annotationNode) {
             }
 
             return Optional.of(new PatternMatch<>(this,
-                    annotationNode.getLinesInDiff().getFromInclusive(), elseNode.getLinesInDiff().getToExclusive(),
+                    annotationNode.getLinesInDiff().fromInclusive(), elseNode.getLinesInDiff().toExclusive(),
                     annotationNode.getFeatureMapping(AFTER)
             ));
         }
diff --git a/src/main/java/org/variantsync/diffdetective/preliminary/pattern/semantic/MoveElse.java b/src/main/java/org/variantsync/diffdetective/preliminary/pattern/semantic/MoveElse.java
@@ -48,7 +48,7 @@ public Optional<PatternMatch<DiffNode>> match(DiffNode annotationNode) {
             }
 
             return Optional.of(new PatternMatch<>(this,
-                    annotationNode.getLinesInDiff().getFromInclusive(), removedElse.getLinesInDiff().getToExclusive()
+                    annotationNode.getLinesInDiff().fromInclusive(), removedElse.getLinesInDiff().toExclusive()
             ));
         }
 
diff --git a/src/main/java/org/variantsync/diffdetective/show/Show.java b/src/main/java/org/variantsync/diffdetective/show/Show.java
@@ -39,8 +39,8 @@ public static GameEngine tree(final VariationTree t) {
     public static GameEngine baddiff(final BadVDiff badVDiff, final String title) {
         final DiffTree d = badVDiff.diff().toDiffTree(
             v -> {
-                int from = v.getLineRange().getFromInclusive();
-                int to = v.getLineRange().getToExclusive();
+                int from = v.getLineRange().fromInclusive();
+                int to = v.getLineRange().toExclusive();
 
                 return new DiffNode(
                         badVDiff.coloring().get(v),
diff --git a/src/main/java/org/variantsync/diffdetective/util/LineRange.java b/src/main/java/org/variantsync/diffdetective/util/LineRange.java
@@ -3,17 +3,15 @@
 /**
  * Class to hold a range of line numbers.
  * Mainly used to locate code snippets in source code files and textual diffs.
+ * @param fromInclusive The starting line number of this range. This number is included within the range.
+ * @param toExclusive The ending line number of this range. This number is excluded from the range
+ *                    (i.e., it points to the line right after the last line).
  * @author Paul Bittner
  */
-public class LineRange {
-    private final int fromInclusive; // including
-    private final int toExclusive; // excluding
-
-    private LineRange(int fromInclusive, int toExclusive) {
-        this.fromInclusive = fromInclusive;
-        this.toExclusive = toExclusive;
-    }
-
+public record LineRange(
+        int fromInclusive,
+        int toExclusive
+) {
     /**
      * Creates an invalid range that does not represent a valid range of line numbers in a text file.
      */
@@ -47,26 +45,6 @@ public static LineRange FromInclToIncl(int fromInclusive, int toInclusive) {
         return new LineRange(fromInclusive, toInclusive + 1);
     }
 
-    /**
-     * Returns the starting line number of this range.
-     * This number is included within the range.
-     */
-    public int getFromInclusive() {
-        return fromInclusive;
-    }
-
-    /**
-     * Returns the ending line number of this range.
-     * This number is excluded from the range (i.e., it points to the line right after the last line).
-     */
-    public int getToExclusive() {
-        return toExclusive;
-    }
-
-//    public int getToInclusive() {
-//        return toExclusive;
-//    }
-
 
     @Override
     public String toString() {
diff --git a/src/main/java/org/variantsync/diffdetective/variation/diff/DiffNode.java b/src/main/java/org/variantsync/diffdetective/variation/diff/DiffNode.java
@@ -510,8 +510,8 @@ public LineRange getLinesAtTime(Time time) {
      * the edit.
      */
     public void setLinesAtTime(LineRange lineRange, Time time) {
-        from = from.withLineNumberAtTime(lineRange.getFromInclusive(), time);
-        to = to.withLineNumberAtTime(lineRange.getToExclusive(), time);
+        from = from.withLineNumberAtTime(lineRange.fromInclusive(), time);
+        to = to.withLineNumberAtTime(lineRange.toExclusive(), time);
     }
 
     /**
@@ -776,8 +776,8 @@ public Projection projection(Time time) {
      * to itself. Acts on only the given node and does not perform recursive translations.
      */
     public static <T extends VariationNode<T>> DiffNode unchangedFlat(T variationNode) {
-        int from = variationNode.getLineRange().getFromInclusive();
-        int to = variationNode.getLineRange().getToExclusive();
+        int from = variationNode.getLineRange().fromInclusive();
+        int to = variationNode.getLineRange().toExclusive();
 
         return new DiffNode(
                 DiffType.NON,
diff --git a/src/main/java/org/variantsync/diffdetective/variation/tree/VariationTreeNode.java b/src/main/java/org/variantsync/diffdetective/variation/tree/VariationTreeNode.java
@@ -290,7 +290,7 @@ public Node getFormula() {
     @Override
     public int getID() {
         // Add one to ensure invalid (negative) line numbers don't cause issues.
-        final int lineNumber = 1 + getLineRange().getFromInclusive();
+        final int lineNumber = 1 + getLineRange().fromInclusive();
 
         final int usedBitCount = DiffType.getRequiredBitCount() + NodeType.getRequiredBitCount();
         Assert.assertTrue((lineNumber << usedBitCount) >> usedBitCount == lineNumber);

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ public PatternMatch<DiffNode> createMatch(DiffNode codeNode) {`
`24`	`24`	`final LineRange diffLines = codeNode.getLinesInDiff();`
`25`	`25`
`26`	`26`	`return new PatternMatch<>(this,`
`27`		`- diffLines.getFromInclusive(), diffLines.getToExclusive(), fm`
	`27`	`+ diffLines.fromInclusive(), diffLines.toExclusive(), fm`
`28`	`28`	`);`
`29`	`29`	`}`
`30`	`30`
Original file line number	Diff line number	Diff line change
`@@ -24,8 +24,8 @@ public PatternMatch<DiffNode> createMatch(DiffNode codeNode) {`
`24`	`24`	`final LineRange diffLines = codeNode.getLinesInDiff();`
`25`	`25`
`26`	`26`	`return new PatternMatch<>(this,`
`27`		`- diffLines.getFromInclusive(),`
`28`		`- diffLines.getToExclusive(), fm`
	`27`	`+ diffLines.fromInclusive(),`
	`28`	`+ diffLines.toExclusive(), fm`
`29`	`29`	`);`
`30`	`30`	`}`
`31`	`31`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ public Pattern<DiffNode> getPattern() {`
`19`	`19`	`public PatternMatch<DiffNode> createMatch(DiffNode codeNode) {`
`20`	`20`	`final LineRange diffLines = codeNode.getLinesInDiff();`
`21`	`21`	`return new PatternMatch<>(this,`
`22`		`- diffLines.getFromInclusive(), diffLines.getToExclusive()`
	`22`	`+ diffLines.fromInclusive(), diffLines.toExclusive()`
`23`	`23`	`);`
`24`	`24`	`}`
`25`	`25`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ public Optional<PatternMatch<DiffNode>> match(DiffNode annotationNode) {`
`49`	`49`
`50`	`50`	`final LineRange diffLines = annotationNode.getLinesInDiff();`
`51`	`51`	`return Optional.of(new PatternMatch<>(this,`
`52`		`- diffLines.getFromInclusive(), diffLines.getToExclusive(),`
	`52`	`+ diffLines.fromInclusive(), diffLines.toExclusive(),`
`53`	`53`	`mappings.toArray(new Node[0])`
`54`	`54`	`));`
`55`	`55`	`}`