Class SyntheticModuleRecord

java.lang.Object

com.oracle.truffle.js.runtime.objects.ScriptOrModule

com.oracle.truffle.js.runtime.objects.AbstractModuleRecord

com.oracle.truffle.js.runtime.objects.SyntheticModuleRecord

public final class SyntheticModuleRecord
extends AbstractModuleRecord

A Synthetic Module Record, used for JSON modules, etc. Its exported names are statically defined at creation, while their corresponding values can change over time using SetSyntheticModuleExport. It has no imports or dependencies.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	SyntheticModuleRecord.SharedData

Field Summary

Fields inherited from class ScriptOrModule

context, source

Constructor Summary

Constructors

Constructor	Description
SyntheticModuleRecord(JSContext context, com.oracle.truffle.api.source.Source source, Object hostDefined, SyntheticModuleRecord.SharedData shared, Consumer<SyntheticModuleRecord> evaluationSteps)
SyntheticModuleRecord(JSContext context, com.oracle.truffle.api.source.Source source, Object hostDefined, List<com.oracle.truffle.api.strings.TruffleString> exportedNames, Consumer<SyntheticModuleRecord> evaluationSteps)

Method Summary

Modifier and Type	Method	Description
JSPromiseObject	evaluate(JSRealm realm)	Returns a promise for the evaluation of this module and its dependencies, resolving on successful evaluation or if it has already been evaluated successfully, and rejecting for an evaluation error or if it has already been evaluated unsuccessfully.
void	evaluateSync(JSRealm realm)
Collection<com.oracle.truffle.api.strings.TruffleString>	getExportedNames(Set<JSModuleRecord> exportStarSet)
Object	getModuleSource()
CyclicModuleRecord.Status	getStatus()	Off-spec extension: Provides a status for Node.js.
void	link(JSRealm realm)	Prepare the module for evaluation by transitively resolving all module dependencies and creating a Module Environment Record.
JSPromiseObject	loadRequestedModules(JSRealm realm, Object hostDefinedArg)	Prepares the module for linking by recursively loading all its dependencies.
ExportResolution	resolveExport(com.oracle.truffle.api.strings.TruffleString exportName, Set<Pair<? extends AbstractModuleRecord, com.oracle.truffle.api.strings.TruffleString>> resolveSet)
void	setSyntheticModuleExport(com.oracle.truffle.api.strings.TruffleString exportName, Object exportValue)
String	toString()

Methods inherited from class AbstractModuleRecord

clearEnvironment, gatherAsynchronousTransitiveDependencies, getEnvironment, getExportedNames, getFrameDescriptor, getHostDefined, getModuleNamespace, getModuleNamespace, getModuleNamespaceOrNull, getModuleNamespaceOrNull, loadRequestedModulesSync, resolveExport, setEnvironment, setFrameDescriptor

Methods inherited from class ScriptOrModule

addLoadedModule, getContext, getSource, rememberImportedModuleSource

Methods inherited from class Object

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

Constructor Details

SyntheticModuleRecord

public SyntheticModuleRecord(JSContext context,
 com.oracle.truffle.api.source.Source source,
 Object hostDefined,
 List<com.oracle.truffle.api.strings.TruffleString> exportedNames,
 Consumer<SyntheticModuleRecord> evaluationSteps)

SyntheticModuleRecord

public SyntheticModuleRecord(JSContext context,
 com.oracle.truffle.api.source.Source source,
 Object hostDefined,
 SyntheticModuleRecord.SharedData shared,
 Consumer<SyntheticModuleRecord> evaluationSteps)

Method Details

loadRequestedModules

public JSPromiseObject loadRequestedModules(JSRealm realm,
 Object hostDefinedArg)

Description copied from class: AbstractModuleRecord

Prepares the module for linking by recursively loading all its dependencies.

Specified by:

loadRequestedModules in class AbstractModuleRecord

link

public void link(JSRealm realm)

Description copied from class: AbstractModuleRecord

Prepare the module for evaluation by transitively resolving all module dependencies and creating a Module Environment Record. LoadRequestedModules must have completed successfully prior to invoking this method.

Specified by:

link in class AbstractModuleRecord

evaluate

public JSPromiseObject evaluate(JSRealm realm)

Description copied from class: AbstractModuleRecord

Returns a promise for the evaluation of this module and its dependencies, resolving on successful evaluation or if it has already been evaluated successfully, and rejecting for an evaluation error or if it has already been evaluated unsuccessfully. Link must have completed successfully prior to invoking this method.

Specified by:

evaluate in class AbstractModuleRecord

evaluateSync

public void evaluateSync(JSRealm realm)

Overrides:

evaluateSync in class AbstractModuleRecord

getExportedNames

public Collection<com.oracle.truffle.api.strings.TruffleString> getExportedNames(Set<JSModuleRecord> exportStarSet)

Specified by:

getExportedNames in class AbstractModuleRecord

resolveExport

public ExportResolution resolveExport(com.oracle.truffle.api.strings.TruffleString exportName,
 Set<Pair<? extends AbstractModuleRecord, com.oracle.truffle.api.strings.TruffleString>> resolveSet)

Specified by:

resolveExport in class AbstractModuleRecord

setSyntheticModuleExport

public void setSyntheticModuleExport(com.oracle.truffle.api.strings.TruffleString exportName,
 Object exportValue)

getModuleSource

public Object getModuleSource()

Specified by:

getModuleSource in class AbstractModuleRecord

getStatus

public CyclicModuleRecord.Status getStatus()

Off-spec extension: Provides a status for Node.js. Can only be New, Linked, or Evaluated.

Specified by:

getStatus in class AbstractModuleRecord

toString

public String toString()

Overrides:

toString in class Object