ScriptingWorkspace class abstract

A workspace represents a collection of files that are likely related (usually part of a single Rive file).

Constructors

ScriptingWorkspace()

Properties

builtinDefinitions → String

no setter

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

autocomplete(String scriptName, ScriptPosition position) → Future<AutocompleteResult>

Get possible autocompletion results at position in script with name scriptName.

checkScriptsWithRequires() → void

compile(String scriptName, {bool failOnErrors = false, bool compileDependencies = false, OptimizationLevel optimizationLevel = OptimizationLevel.medium, DebugLevel debugLevel = DebugLevel.medium}) → Future<CompileResult?>

Retrieves the bytecode for module named scriptName.

compileAndSign(Iterable<String> scriptNames, Uint8List privateKey, {bool failOnErrors = false, OptimizationLevel optimizationLevel = OptimizationLevel.medium, DebugLevel debugLevel = DebugLevel.medium}) → Future<CompileAndSignResult?>

Retrieves the bytecode for listed modules and signature.

completeInsertion(String scriptName, ScriptPosition position) → InsertionCompletion

Get extra text insertion to be auto-completed at the given position.

completeWork(Completer completer, ScriptingWorkspaceResponseResult response) → void

dispose() → void

Dispose of the workspace, any further calls will not work.

findInFiles(Iterable<String>? inclusionSet, String query, {bool caseSensitive = false, bool matchWholeWord = false, bool regularExpression = false, bool trim = true}) → Future<FindInFilesResult>

Searches for query in files. If inclusionSet is provided, only those files are searched, otherwise all non-built-in files are searched.

format(String scriptName) → Future<FormatResult>

Formats module named scriptName.

fullProblemReport() → Future<List<ScriptProblemResult>>

Get an error report for all the script files in this workspace.

getDefinition(String scriptName, ScriptPosition position) → Future<DefinitionResult>

Get definition information at position in script with name scriptName.

implementedType(String scriptName) → Future<ImplementedType?>

Retrieves the implemented type for module named scriptName.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

problemReport(String scriptName) → Future<ScriptProblemResult>

Get an error report for a script file with identified by scriptName.

registerCompleter<T>(int workId) → Future<T>

removeScriptSource(String scriptId) → void

responseForWork(int workId) → ScriptingWorkspaceResponseResult

rowHighlight(String scriptName, int row) → Uint32List

Get the highlight data for a single row of scriptName.

setScriptSource(String scriptId, String scriptName, String source, {bool highlight = false}) → Future<HighlightResult>

Set the source code for the script with scriptId. Calling this again with the same scriptId will overwrite the script. Set highlight to true if you'd like to have highlighting data computed. scriptName is the name used to require this script.

setSystemGeneratedSource(String scriptName, String prefix, String source) → Future<HighlightResult>

toString() → String

A string representation of this object.

inherited

workReadyCallback(int workId) → void

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

make() → ScriptingWorkspace

nativeFontBytes() → Uint8List