Merge remote-tracking branch 'origin/GP-0-dragonmacher-test-fixes-4-26-25--SQUASHED'

Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/ImmutableAddressSet.java

@@ -0,0 +1,226 @@
+/* ###
+ * IP: GHIDRA
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package ghidra.program.model.address;
+
+import java.util.Iterator;
+
+/**
+ * Immutable implementation of the {@link AddressSetView} interface;
+ */
+public class ImmutableAddressSet implements AddressSetView {
+
+	public static final ImmutableAddressSet EMPTY_SET = new ImmutableAddressSet(new AddressSet());
+
+	public static ImmutableAddressSet asImmutable(AddressSetView view) {
+		if (view == null) {
+			return EMPTY_SET;
+		}
+		if (view instanceof ImmutableAddressSet ias) {
+			return ias;
+		}
+		return new ImmutableAddressSet(view);
+	}
+
+	private AddressSet set;
+
+	public ImmutableAddressSet(AddressSetView addresses) {
+		set = new AddressSet(addresses);
+	}
+
+	@Override
+	public boolean contains(Address addr) {
+		return set.contains(addr);
+	}
+
+	@Override
+	public boolean contains(Address start, Address end) {
+		return set.contains(start, end);
+	}
+
+	@Override
+	public boolean contains(AddressSetView rangeSet) {
+		return set.contains(rangeSet);
+	}
+
+	@Override
+	public boolean isEmpty() {
+		return set.isEmpty();
+	}
+
+	@Override
+	public Address getMinAddress() {
+		return set.getMinAddress();
+	}
+
+	@Override
+	public Address getMaxAddress() {
+		return set.getMaxAddress();
+	}
+
+	@Override
+	public int getNumAddressRanges() {
+		return set.getNumAddressRanges();
+	}
+
+	@Override
+	public AddressRangeIterator getAddressRanges() {
+		return set.getAddressRanges();
+	}
+
+	@Override
+	public AddressRangeIterator getAddressRanges(boolean forward) {
+		return set.getAddressRanges(forward);
+	}
+
+	@Override
+	public AddressRangeIterator getAddressRanges(Address start, boolean forward) {
+		return set.getAddressRanges(start, forward);
+	}
+
+	@Override
+	public Iterator<AddressRange> iterator() {
+		return set.iterator();
+	}
+
+	@Override
+	public Iterator<AddressRange> iterator(boolean forward) {
+		return set.iterator(forward);
+	}
+
+	@Override
+	public Iterator<AddressRange> iterator(Address start, boolean forward) {
+		return set.iterator(start, forward);
+	}
+
+	@Override
+	public long getNumAddresses() {
+		return set.getNumAddresses();
+	}
+
+	@Override
+	public AddressIterator getAddresses(boolean forward) {
+		return set.getAddresses(forward);
+	}
+
+	@Override
+	public AddressIterator getAddresses(Address start, boolean forward) {
+		return set.getAddresses(start, forward);
+	}
+
+	@Override
+	public boolean intersects(AddressSetView addrSet) {
+		return set.intersects(addrSet);
+	}
+
+	@Override
+	public boolean intersects(Address start, Address end) {
+		return set.intersects(start, end);
+	}
+
+	@Override
+	public AddressSet intersect(AddressSetView view) {
+		return set.intersect(view);
+	}
+
+	@Override
+	public AddressSet intersectRange(Address start, Address end) {
+		return set.intersectRange(start, end);
+	}
+
+	@Override
+	public AddressSet union(AddressSetView addrSet) {
+		return set.union(addrSet);
+	}
+
+	@Override
+	public AddressSet subtract(AddressSetView addrSet) {
+		return set.subtract(addrSet);
+	}
+
+	@Override
+	public AddressSet xor(AddressSetView addrSet) {
+		return set.xor(addrSet);
+	}
+
+	@Override
+	public boolean hasSameAddresses(AddressSetView view) {
+		return set.hasSameAddresses(view);
+	}
+
+	@Override
+	public AddressRange getFirstRange() {
+		return set.getFirstRange();
+	}
+
+	@Override
+	public AddressRange getLastRange() {
+		return set.getLastRange();
+	}
+
+	@Override
+	public AddressRange getRangeContaining(Address address) {
+		return set.getRangeContaining(address);
+	}
+
+	@Override
+	public Address findFirstAddressInCommon(AddressSetView addresses) {
+		return set.findFirstAddressInCommon(addresses);
+	}
+
+	@Override
+	public final boolean equals(Object obj) {
+		if (obj == null) {
+			return false;
+		}
+
+		if (obj == this) {
+			return true;
+		}
+
+		if (!(obj instanceof ImmutableAddressSet)) {
+			return false;
+		}
+
+		ImmutableAddressSet otherSet = (ImmutableAddressSet) obj;
+		if (this.getNumAddresses() != otherSet.getNumAddresses()) {
+			return false;
+		}
+
+		// if don't have same number of ranges, not equal
+		if (this.getNumAddressRanges() != otherSet.getNumAddressRanges()) {
+			return false;
+		}
+
+		AddressRangeIterator otherRanges = otherSet.getAddressRanges();
+		AddressRangeIterator myRanges = getAddressRanges();
+		while (myRanges.hasNext()) {
+			AddressRange myRange = myRanges.next();
+			AddressRange otherRange = otherRanges.next();
+			if (!myRange.equals(otherRange)) {
+				return false;
+			}
+		}
+		return true;
+	}
+
+	@Override
+	public int hashCode() {
+		if (isEmpty()) {
+			return 0;
+		}
+		return getMinAddress().hashCode() + getMaxAddress().hashCode();
+	}
+}