org.checkerframework.common.wholeprograminference.scenelib

Class ASceneWrapper

java.lang.Object

org.checkerframework.common.wholeprograminference.scenelib.ASceneWrapper

public class ASceneWrapper
extends Object

scene-lib (from the Annotation File Utilities) doesn't provide enough information to usefully print stub files: it lacks information about what is and is not an enum, about the base types of variables, and about formal parameter names.

This class wraps AScene but provides access to that missing information. This allows us to preserve the code that generates .jaif files, while allowing us to sanely and safely keep the information we need to generate stubs.

This class would be better as a subclass of AScene.

Constructor Summary

Constructors

Constructor and Description
ASceneWrapper(scenelib.annotations.el.AScene theScene) Constructor.

Method Summary

Modifier and Type	Method and Description
scenelib.annotations.el.AScene	getAScene() Avoid using this if possible; use the other methods of this class unless you absolutely need an AScene.
void	updateSymbolInformation(scenelib.annotations.el.AClass aClass, @Nullable com.sun.tools.javac.code.Symbol.ClassSymbol classSymbol) Updates the symbol information stored in AClass for the given class.
void	writeToFile(String jaifPath, WholeProgramInferenceScenesStorage.AnnotationsInContexts annosToIgnore, WholeProgramInference.OutputFormat outputFormat, BaseTypeChecker checker) Write the scene wrapped by this object to a file at the given path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ASceneWrapper

public ASceneWrapper(scenelib.annotations.el.AScene theScene)

Constructor. Pass the AScene to wrap.

Parameters:

theScene - the scene to wrap

Method Detail

writeToFile

public void writeToFile(String jaifPath,
                        WholeProgramInferenceScenesStorage.AnnotationsInContexts annosToIgnore,
                        WholeProgramInference.OutputFormat outputFormat,
                        BaseTypeChecker checker)

Write the scene wrapped by this object to a file at the given path.

Parameters:

jaifPath - the path of the file to be written, but ending in ".jaif". If outputformat is not JAIF, the path will be modified to match.

annosToIgnore - which annotations should be ignored in which contexts

outputFormat - the output format to use

checker - the checker from which this method is called, for naming stub files

updateSymbolInformation

public void updateSymbolInformation(scenelib.annotations.el.AClass aClass,
                                    @Nullable com.sun.tools.javac.code.Symbol.ClassSymbol classSymbol)

Updates the symbol information stored in AClass for the given class. May be called multiple times (and needs to be if the second parameter was null the first time it was called; only some calls provide the symbol information).

Parameters:

aClass - the class representation in which the symbol information is to be updated

classSymbol - the source of the symbol information; may be null, in which case this method does nothing

getAScene

public scenelib.annotations.el.AScene getAScene()

Avoid using this if possible; use the other methods of this class unless you absolutely need an AScene.

Returns:

the AScene representation of this