Iterator infrastructure for collection models: snapshot iterators + generic-element annotation - #42
Open
tautschnig wants to merge 1 commit into
Open
Iterator infrastructure for collection models: snapshot iterators + generic-element annotation#42tautschnig wants to merge 1 commit into
tautschnig wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Pull request overview
Adds new org.cprover infrastructure types intended to support iterator/enhanced-for modeling in JBMC collection models and to improve nondet initialization of generic-typed Object[] backing arrays.
Changes:
- Introduces
CProverArrayLikeIterator<E>: a snapshot iterator over anObject[]+ logical size. - Introduces
CProverMapEntry<K,V>: a snapshot/read-onlyMap.Entryimplementation for map entry-set views. - Introduces
@CProverGenericArrayElement: runtime field annotation to markObject[]fields as holding a model class’s generic-parameter elements.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| src/main/java/org/cprover/CProverArrayLikeIterator.java | New snapshot iterator utility for array-backed models (currently not yet wired into existing models). |
| src/main/java/org/cprover/CProverMapEntry.java | New snapshot Map.Entry implementation for map entry iteration/views. |
| src/main/java/org/cprover/CProverGenericArrayElement.java | New runtime annotation to convey generic element types for Object[] backing arrays. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…eneric-element annotation Three top-level org.cprover support classes for collection models' iterator()/enhanced-for support. They are inert until collection models reference them (none in this repo do yet -- the javadoc describes intended usage); landing them separately keeps the model changes reviewable. - CProverArrayLikeIterator<E>: generic snapshot iterator over an Object[]-backed collection; captures (storage, size) at iterator() time. Top-level rather than an inner class deliberately: a non-static inner class's implicit this$0 creates a Collection <-> Iterator lazy-class-loading cycle that aborts JBMC's nondet initialisation of abstract collection parameters. The class javadoc carries the full design rationale (snapshot-vs-fail-fast trade-off, iteration-order conformance, and the documented opt-in future paths for CME modelling and Iterator.remove()). next() past the end throws NoSuchElementException per the JDK contract. An assume() guard on the precondition would be unsound here: it would prune exactly the executions in which target code over-iterates, hiding those bugs behind vacuously-passing paths; modelling the throw keeps them observable with the correct exception type. - CProverMapEntry<K, V>: read-only snapshot Map.Entry for entrySet() views of parallel-array map models. Deliberately final; entry-driven mutation calls for a separate write-through entry class (documented), not subclassing. - @CProverGenericArrayElement: marks an Object[] field as holding a model class's generic-parameter elements, so JBMC's nondet object factory can specialise the element type. Co-authored-by: Kiro <kiro-agent@users.noreply.github.com>
tautschnig
force-pushed
the
iterator-infrastructure
branch
from
July 28, 2026 23:57
15ae667 to
7b301ed
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Three top-level org.cprover support classes for the collection models' iterator()/enhanced-for support:
These are inert until collection models reference them; landing them separately keeps the model changes reviewable.