Class CompileState

A SQRL CompileState represents the state of the SQRL compiler during a single compilation.

Hierarchy

CompileState

Index

Methods

addHashedEntity addStatement combineGlobalWhere debug error fatal getFilesystem info setConstantSlot setGlobal trace warn

Methods

addHashedEntity

addHashedEntity(sourceAst: Ast, entityType: string, props: {
    [key: string]: any;
}): {
    entityAst: SlotAst;
    entityId: EntityId;
}
Creates a node with a hash of the given properties for a node type.
Parameters
- sourceAst: Ast
- entityType: string
- props: {
  [key: string]: any;
  }
  - [key: string]: any
Returns {
entityAst: SlotAst;
entityId: EntityId;
}
- entityAst: SlotAst
- entityId: EntityId
- Defined in packages/sqrl/src/api/parse.ts:117

addStatement

addStatement(name: string, slotAst: SlotAst): void
Adds a statement
Parameters
- name: string
- slotAst: SlotAst
Returns void
- Defined in packages/sqrl/src/api/parse.ts:146

combineGlobalWhere

combineGlobalWhere(where: Ast): {
    combinedAst: Ast;
    whereAst: Ast;
    whereFeatures: string[];
    whereTruth: string;
}
Combines a WHERE statement with the current global WHERE state. Returns a slot as well as hashable truth table for the boolean condition
Parameters
- where: Ast
Returns {
    combinedAst: Ast;
    whereAst: Ast;
    whereFeatures: string[];
    whereTruth: string;
}
- combinedAst: Ast
- whereAst: Ast
- whereFeatures: string[]
- whereTruth: string
- Defined in packages/sqrl/src/api/parse.ts:134

debug

debug(props: LogProperties, format: string, ...param: any[]): any
Logs a message at the debug (second lowest) level
Parameters
- props: LogProperties
- format: string
- Rest ...param: any[]
Returns any
- Defined in packages/sqrl/src/api/parse.ts:160

error

error(props: LogProperties, format: string, ...param: any[]): any
Logs a message at the error (high priority) level
Parameters
- props: LogProperties
- format: string
- Rest ...param: any[]
Returns any
- Defined in packages/sqrl/src/api/parse.ts:181

fatal

fatal(props: LogProperties, format: string, ...param: any[]): any
Logs a message at the fatal (highest priority) level
Parameters
- props: LogProperties
- format: string
- Rest ...param: any[]
Returns any
- Defined in packages/sqrl/src/api/parse.ts:188

getFilesystem

getFilesystem(): Filesystem
Returns the filesystem linked for files associated in this compile

Returns Filesystem
- Defined in packages/sqrl/src/api/parse.ts:91

info

info(props: LogProperties, format: string, ...param: any[]): any
Logs a message at the info (normal) level
Parameters
- props: LogProperties
- format: string
- Rest ...param: any[]
Returns any
- Defined in packages/sqrl/src/api/parse.ts:167

setConstantSlot

setConstantSlot(sourceAst: Ast, name: string, initialValue: any): ConstantSlot
Creates a new global slot if it doesn't already exist. Ensures that the slot is a ConstantSlot and returns an object that can be used to update the value.
Parameters
- sourceAst: Ast
- name: string
- initialValue: any
Returns ConstantSlot
- Defined in packages/sqrl/src/api/parse.ts:108

setGlobal

setGlobal(sourceAst: Ast, valueAst: Ast, name?: string): SlotAst
Creates a new global slot. If there is a problem creating the slot the error message will point to the code in sourceAst.
Parameters
- sourceAst: Ast
- valueAst: Ast
- Optional name: string
Returns SlotAst
- Defined in packages/sqrl/src/api/parse.ts:99

trace

trace(props: LogProperties, format: string, ...param: any[]): any
Logs a message at the trace (lowest) level
Parameters
- props: LogProperties
- format: string
- Rest ...param: any[]
Returns any
- Defined in packages/sqrl/src/api/parse.ts:153

warn

warn(props: LogProperties, format: string, ...param: any[]): any
Logs a message at the warn (priority) level
Parameters
- props: LogProperties
- format: string
- Rest ...param: any[]
Returns any
- Defined in packages/sqrl/src/api/parse.ts:174

Class CompileState

Hierarchy

Index

Methods

Methods

addHashedEntity

Parameters

sourceAst: Ast

entityType: string

props: { [key: string]: any; }

[key: string]: any

Returns { entityAst: SlotAst; entityId: EntityId; }

entityAst: SlotAst

entityId: EntityId

addStatement

Parameters

name: string

slotAst: SlotAst

Returns void

combineGlobalWhere

Parameters

where: Ast

Returns { combinedAst: Ast; whereAst: Ast; whereFeatures: string[]; whereTruth: string; }

combinedAst: Ast

whereAst: Ast

whereFeatures: string[]

whereTruth: string

debug

Parameters

props: LogProperties

format: string

Rest ...param: any[]

Returns any

error

Parameters

props: LogProperties

format: string

Rest ...param: any[]

Returns any

fatal

Parameters

props: LogProperties

format: string

Rest ...param: any[]

Returns any

getFilesystem

Returns Filesystem

info

Parameters

props: LogProperties

format: string

Rest ...param: any[]

Returns any

setConstantSlot

Parameters

sourceAst: Ast

name: string

initialValue: any

Returns ConstantSlot

setGlobal

Parameters

sourceAst: Ast

valueAst: Ast

Optional name: string

Returns SlotAst

trace

Parameters

props: LogProperties

format: string

Rest ...param: any[]

Returns any

warn

Parameters

props: LogProperties

format: string

Rest ...param: any[]

Returns any

Settings

Member Visibility

Theme

props: {
[key: string]: any;
}

Returns {
entityAst: SlotAst;
entityId: EntityId;
}

Returns {
combinedAst: Ast;
whereAst: Ast;
whereFeatures: string[];
whereTruth: string;
}

`Rest` ...param: any[]

`Rest` ...param: any[]

`Rest` ...param: any[]

`Rest` ...param: any[]

`Optional` name: string

`Rest` ...param: any[]

`Rest` ...param: any[]