Class AstCoreFactory

constructor

• new AstCoreFactory(args?: Partial<AstCoreFactoryArgs>): AstCoreFactory

  Parameters

  • args: Partial<AstCoreFactoryArgs> = {}

  Returns AstCoreFactory

tracksSourceLocation

dematerialized

• dematerialized<T extends Node>(arg: T): T

  Returns a copy of the argument that is not materialized

  Type Parameters

  • T extends Node

  Parameters

  • arg: T

  Returns T

forcedAutoGenTree

• forcedAutoGenTree<T extends object>(obj: T): T

  Given a (AST) tree, return a copy of that tree where it and it's descendents all have a SourceLocationNodeAutoGenerate localization.

  Type Parameters

  • T extends object

  Parameters

  • obj: T

  Returns T

forceMaterialized

• forceMaterialized<T extends Node>(arg: T): T

  In case the provided Node is not yet materialized, force it to be autoGenerated.

  Type Parameters

  • T extends Node

  Parameters

  • arg: T

  Returns T

gen

• gen(): SourceLocationNodeAutoGenerate

  Create a SourceLocation indicating the node should be autoGenerated by a generator.

  Returns SourceLocationNodeAutoGenerate

isLocalized

• isLocalized(obj: unknown): obj is Localized

  Whether the provided value is an object that tracks source location.

  Parameters

  • obj: unknown

  Returns obj is Localized

isOfSubType

• isOfSubType<Type extends string, SubType extends string>(
      obj: object,
      type: Type,
      subType: SubType,
  ): obj is SubTyped<Type, SubType>

  Guard to check if an object is the specified Type: SubTyped.

  Type Parameters

  • Type extends string
  • SubType extends string

  Parameters

  • obj: object
  • type: Type
  • subType: SubType

  Returns obj is SubTyped<Type, SubType>

isOfType

• isOfType<Type extends string>(obj: object, type: Type): obj is Typed<Type>

  Guard to check if an object is the specified Type: Typed.

  Type Parameters

  • Type extends string

  Parameters

  • obj: object
  • type: Type

  Returns obj is Typed<Type>

isPrintingLoc

• isPrintingLoc(loc: SourceLocation): boolean

  Check whether the provided SourceLocation expects the generator to autoGenerate.

  Parameters

  • loc: SourceLocation

  Returns boolean

isSourceLocation

• isSourceLocation(loc: object): loc is SourceLocation

  Check whether an object is in fact a SourceLocation.

  Parameters

  • loc: object

  Returns loc is SourceLocation

isSourceLocationInlinedSource

• isSourceLocationInlinedSource(loc: object): loc is SourceLocationInlinedSource

  Guard to check if an object is a SourceLocation of type SourceLocationInlinedSource.

  Parameters

  • loc: object

  Returns loc is SourceLocationInlinedSource

isSourceLocationNodeAutoGenerate

• isSourceLocationNodeAutoGenerate(
      loc: object,
  ): loc is SourceLocationNodeAutoGenerate

  Guard to check if an object is a SourceLocation of type SourceLocationNodeAutoGenerate.

  Parameters

  • loc: object

  Returns loc is SourceLocationNodeAutoGenerate

isSourceLocationNodeReplace

• isSourceLocationNodeReplace(loc: object): loc is SourceLocationNodeReplace

  Guard to check if an object is a SourceLocation of type SourceLocationNodeReplace.

  Parameters

  • loc: object

  Returns loc is SourceLocationNodeReplace

isSourceLocationNoMaterialize

• isSourceLocationNoMaterialize(loc: object): loc is SourceLocationNoMaterialize

  Guard to check if an object is a SourceLocation of type SourceLocationNoMaterialize.

  Parameters

  • loc: object

  Returns loc is SourceLocationNoMaterialize

isSourceLocationSource

• isSourceLocationSource(loc: object): loc is SourceLocationSource

  Guard to check if an object is a SourceLocation of type SourceLocationSource.

  Parameters

  • loc: object

  Returns loc is SourceLocationSource

isSourceLocationStringReplace

• isSourceLocationStringReplace(loc: object): loc is SourceLocationStringReplace

  Guard to check if an object is a SourceLocation of type SourceLocationStringReplace.

  Parameters

  • loc: object

  Returns loc is SourceLocationStringReplace

printFilter

• printFilter(node: Localized, callback: () => void): void

  A simple filter that will only execute the provided callback when the provided SourceLocation expects the generator steps to autoGenerate.

  Parameters

  • node: Localized
  • callback: () => void

  Returns void

safeObjectTransform

• safeObjectTransform(value: unknown, mapper: (some: object) => any): any

  Given a value and some mapper from objects to objects, map all containing items in case it is an array, otherwise map the provided value in case it is an object, finally, do nothing.

  Parameters

  • value: unknown

    the value to map

  • mapper: (some: object) => any

    the function mapping an object to another object.

  Returns any

sourceLocation

• sourceLocation(...elements: (IToken | Localized | undefined)[]): SourceLocation

  Compute the source location of an element based on the elements it contains. The provided arguments should be in order of occurrence in the string.

  Parameters

  • ...elements: (IToken | Localized | undefined)[]

  Returns SourceLocation

sourceLocationInlinedSource

• sourceLocationInlinedSource(
      newSource: string,
      subLoc: SourceLocation,
      start: number,
      end: number,
      startOnNew?: number,
      endOnNew?: number,
  ): SourceLocation

  Create a SourceLocation that indicates a given range of the current range should be replaced by a new source.

  Parameters

  • newSource: string
  • subLoc: SourceLocation
  • start: number
  • end: number
  • startOnNew: number = 0
  • endOnNew: number = newSource.length

  Returns SourceLocation

sourceLocationNodeReplace

• sourceLocationNodeReplace(
      location: SourceLocationSource,
  ): SourceLocationNodeReplace

  Parameters

  • location: SourceLocationSource

  Returns SourceLocationNodeReplace

• sourceLocationNodeReplace(start: number, end: number): SourceLocationNodeReplace

  Parameters

  • start: number
  • end: number

  Returns SourceLocationNodeReplace

sourceLocationNodeReplaceUnsafe

• sourceLocationNodeReplaceUnsafe(loc: SourceLocation): SourceLocationNodeReplace

  Given a sourceLocation, generate a new SourceLocation that indicates the range of the given location should now be autoGenerated

  Parameters

  • loc: SourceLocation

  Returns SourceLocationNodeReplace

sourceLocationNoMaterialize

• sourceLocationNoMaterialize(): SourceLocation

  Generate a source location indicating the no materialization.

  Returns SourceLocation

sourceLocationSource

• sourceLocationSource(start: number, end: number): SourceLocationSource

  Create a SourceLocation that indicates what range of characters this node represents in the source string.

  Parameters

  • start: number
  • end: number

  Returns SourceLocationSource

sourceLocationStringReplace

• sourceLocationStringReplace(
      newSource: string,
      start: number,
      end: number,
  ): SourceLocation

  Create a SourceLocation that indicates this node, representing a range of characters in the original string, should be replaced by some string during generation.

  Parameters

  • newSource: string
  • start: number
  • end: number

  Returns SourceLocation

wrap

• wrap<T>(val: T, loc: SourceLocation): Wrap<T>

  Wrap any type into an object that tracks the source location of tha value.

  Type Parameters

  • T

  Parameters

  • val: T

    the value to wrap

  • loc: SourceLocation

    the source location for that value

  Returns Wrap<T>