Improved treatment of final fields

[mattulbrich]

Intended Change

Final fields cannot change their value after a single assignment in the constructor. In the current KeY logic, final fields are treated like normal fields stored on the heap. This is highly inefficient since heap assignments cannot have an impact on final fields at all.

The plan is hence to access final fields using a function of their own that does not depend on the heap, unlike other fields

T::select(Heap, Object, Field)   // for non-final fields
T::final(Object, Field)  // for final fields

The major challenges include

• adapting reading of final fields in modalities
• adapting accessing final fields in JML
• handling constructors: they are allowed to write.

Writing must somehow be restricted since any modality could write to final fields and thus compromise proofs if thus different inconsistent values for final fields are around on a sequent.

Plan

• Add functions for finals, add a taclet option
• Implement rules that act upon those taclet options
• Implement special treatment for constructors
• Test effectiveness
• Code cleanup
• Document the changes

The following new items showed up:

• Deal with prettyprinting of final fields using select. Currently o.f is the prettyprinting for both accesses.
• Deal with parsing of final fields in JavaDL. o.f means something different now ...
• static final fields are a challenge since they need double special treatment in parsing and prettyprinting

Type of pull request

• Breaking change (feature that cause existing functionality to change)

The plan is to have a taclet otion to fall back to old behaviour.

Ensuring quality

To do:

• I made sure that introduced/changed code is well documented (javadoc and inline comments).
• I made sure that new/changed end-user features are well documented (https://github.com/KeYProject/key-docs).
• I added new test case(s) for new functionality.
• I have checked that runtime performance has not deteriorated.

Additional information and contact(s)

It is the modernised version of #3189.

@WolframPfeifer @wadoon

The contributions within this pull request are licensed under GPLv2 (only) for inclusion in KeY.

[wadoon]

Is #3189 now obsolete?

Interestingly, final is not so final on bytecode level.

[mattulbrich]

Is #3189 now obsolete?

This is the commits from back then merged onto the modern main.

Interestingly, final is not so final on bytecode level.

There are a few source code level things that get lost on byte code. Also generics. Sometimes private fields are not so private in byte code. We operate on source code level and assume that all code is compiler-conformant.

[mattulbrich]

The last commits add sound special treatment for constructors.

[codecov]

Codecov Report

Attention: Patch coverage is 59.29204% with 138 lines in your changes missing coverage. Please review.

Project coverage is 38.36%. Comparing base (db23498) to head (27f1584).
Report is 7 commits behind head on main.

Files with missing lines	Patch %	Lines
...src/main/java/de/uka/ilkd/key/pp/FinalPrinter.java	30.68%	54 Missing and 7 partials ⚠️
...a/ilkd/key/proof/init/FinalFieldCodeValidator.java	61.95%	20 Missing and 15 partials ⚠️
...kd/key/java/declaration/VariableSpecification.java	45.45%	6 Missing and 6 partials ⚠️
...ka/ilkd/key/proof/init/FinalFieldsPOExtension.java	76.66%	2 Missing and 5 partials ⚠️
.../de/uka/ilkd/key/speclang/njml/JmlTermFactory.java	0.00%	5 Missing ⚠️
...c/main/java/de/uka/ilkd/key/logic/TermBuilder.java	42.85%	2 Missing and 2 partials ⚠️
.../java/de/uka/ilkd/key/ldt/FinalHeapResolution.java	78.57%	2 Missing and 1 partial ⚠️
...e/uka/ilkd/key/rule/UseDependencyContractRule.java	0.00%	3 Missing ⚠️
...ka/ilkd/key/nparser/builder/ExpressionBuilder.java	60.00%	1 Missing and 1 partial ⚠️
...src/main/java/de/uka/ilkd/key/pp/FieldPrinter.java	89.47%	1 Missing and 1 partial ⚠️
... and 4 more

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #3495      +/-   ##
============================================
+ Coverage     38.19%   38.36%   +0.17%     
- Complexity    17228    17341     +113     
============================================
  Files          2111     2115       +4     
  Lines        127642   127942     +300     
  Branches      21463    21512      +49     
============================================
+ Hits          48750    49084     +334     
+ Misses        72903    72819      -84     
- Partials       5989     6039      +50     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.