Module aya.cli.impl
Package org.aya.cli.library.source

Record Class LibrarySource

java.lang.Object
java.lang.Record
org.aya.cli.library.source.LibrarySource
Record Components:
program - initialized after parse
tycked - initialized after tyck
resolveInfo - initialized after resolve
All Implemented Interfaces:
org.aya.syntax.GenericAyaFile
public record LibrarySource(@NotNull LibraryOwner owner, @NotNull Path underlyingFile, boolean isLiterate, @NotNull kala.collection.mutable.MutableList<LibrarySource> imports, @NotNull kala.value.MutableValue<kala.collection.immutable.ImmutableSeq<org.aya.syntax.concrete.stmt.Stmt>> program, @NotNull kala.value.MutableValue<kala.collection.immutable.ImmutableSeq<org.aya.syntax.core.def.TyckDef>> tycked, @NotNull kala.value.MutableValue<org.aya.resolve.ResolveInfo> resolveInfo, @NotNull kala.value.MutableValue<LiterateData> literateData) extends Record implements org.aya.syntax.GenericAyaFile
A source file may or may not be tycked.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.aya.syntax.GenericAyaFile

    org.aya.syntax.GenericAyaFile.Factory

  • Constructor Summary

    Constructors
    Constructor
    Description
    LibrarySource(@NotNull LibraryOwner owner, @NotNull Path underlyingFile, boolean isLiterate, @NotNull kala.collection.mutable.MutableList<LibrarySource> imports, @NotNull kala.value.MutableValue<kala.collection.immutable.ImmutableSeq<org.aya.syntax.concrete.stmt.Stmt>> program, @NotNull kala.value.MutableValue<kala.collection.immutable.ImmutableSeq<org.aya.syntax.core.def.TyckDef>> tycked, @NotNull kala.value.MutableValue<org.aya.resolve.ResolveInfo> resolveInfo, @NotNull kala.value.MutableValue<LiterateData> literateData)
    Creates an instance of a LibrarySource record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull org.aya.util.error.SourceFile
    codeFile()
     
    @NotNull Path
    compiledCorePath()
     
    static @NotNull LibrarySource
    create(@NotNull LibraryOwner owner, @NotNull Path file)
     
    @NotNull Path
    displayPath()
     
    boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    int
    hashCode()
    Returns a hash code value for this object.
    @NotNull kala.collection.mutable.MutableList<LibrarySource>
    imports()
    Returns the value of the imports record component.
    boolean
    isLiterate()
    Returns the value of the isLiterate record component.
    @NotNull org.aya.literate.Literate
    literate()
     
    @NotNull kala.value.MutableValue<LiterateData>
    literateData()
    Returns the value of the literateData record component.
    @NotNull org.aya.syntax.ref.ModulePath
    moduleName()
     
    void
    notifyTycked(@NotNull org.aya.resolve.ResolveInfo moduleResolve, @NotNull kala.collection.immutable.ImmutableSeq<org.aya.syntax.core.def.TyckDef> tycked)
     
    @NotNull org.aya.util.error.SourceFile
    originalFile()
     
    @NotNull org.aya.util.error.SourceFile
    originalFile(@NotNull String sourceCode)
     
    @NotNull LibraryOwner
    owner()
    Returns the value of the owner record component.
    @NotNull kala.collection.immutable.ImmutableSeq<org.aya.syntax.concrete.stmt.Stmt>
    parseMe(@NotNull org.aya.syntax.GenericAyaParser parser)
     
    @NotNull org.aya.pretty.doc.Doc
    pretty(@NotNull kala.collection.immutable.ImmutableSeq<org.aya.util.reporter.Problem> problems, @NotNull org.aya.util.prettier.PrettierOptions options)
     
    @NotNull kala.value.MutableValue<kala.collection.immutable.ImmutableSeq<org.aya.syntax.concrete.stmt.Stmt>>
    program()
    Returns the value of the program record component.
    @NotNull kala.value.MutableValue<org.aya.resolve.ResolveInfo>
    resolveInfo()
    Returns the value of the resolveInfo record component.
    String
    toString()
    Returns a string representation of this record class.
    @NotNull kala.value.MutableValue<kala.collection.immutable.ImmutableSeq<org.aya.syntax.core.def.TyckDef>>
    tycked()
    Returns the value of the tycked record component.
    @NotNull Path
    underlyingFile()
    Returns the value of the underlyingFile record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • LibrarySource

      public LibrarySource(@NotNull @NotNull LibraryOwner owner, @NotNull @NotNull Path underlyingFile, boolean isLiterate, @NotNull @NotNull kala.collection.mutable.MutableList<LibrarySource> imports, @NotNull @NotNull kala.value.MutableValue<kala.collection.immutable.ImmutableSeq<org.aya.syntax.concrete.stmt.Stmt>> program, @NotNull @NotNull kala.value.MutableValue<kala.collection.immutable.ImmutableSeq<org.aya.syntax.core.def.TyckDef>> tycked, @NotNull @NotNull kala.value.MutableValue<org.aya.resolve.ResolveInfo> resolveInfo, @NotNull @NotNull kala.value.MutableValue<LiterateData> literateData)
      Creates an instance of a LibrarySource record class.
      Parameters:
      owner - the value for the owner record component
      underlyingFile - the value for the underlyingFile record component
      isLiterate - the value for the isLiterate record component
      imports - the value for the imports record component
      program - the value for the program record component
      tycked - the value for the tycked record component
      resolveInfo - the value for the resolveInfo record component
      literateData - the value for the literateData record component

  • Method Details

    • create

      @NotNull public static @NotNull LibrarySource create(@NotNull @NotNull LibraryOwner owner, @NotNull @NotNull Path file)

    • moduleName

      @NotNull public @NotNull org.aya.syntax.ref.ModulePath moduleName()

    • displayPath

      @NotNull public @NotNull Path displayPath()

    • notifyTycked

      public void notifyTycked(@NotNull @NotNull org.aya.resolve.ResolveInfo moduleResolve, @NotNull @NotNull kala.collection.immutable.ImmutableSeq<org.aya.syntax.core.def.TyckDef> tycked)

    • pretty

      @NotNull public @NotNull org.aya.pretty.doc.Doc pretty(@NotNull @NotNull kala.collection.immutable.ImmutableSeq<org.aya.util.reporter.Problem> problems, @NotNull @NotNull org.aya.util.prettier.PrettierOptions options) throws IOException
      Throws:
      IOException

    • parseMe

      @NotNull public @NotNull kala.collection.immutable.ImmutableSeq<org.aya.syntax.concrete.stmt.Stmt> parseMe(@NotNull @NotNull org.aya.syntax.GenericAyaParser parser) throws IOException
      Specified by:
      parseMe in interface org.aya.syntax.GenericAyaFile
      Throws:
      IOException

    • literate

      @NotNull public @NotNull org.aya.literate.Literate literate() throws IOException
      Specified by:
      literate in interface org.aya.syntax.GenericAyaFile
      Throws:
      IOException

    • codeFile

      @NotNull public @NotNull org.aya.util.error.SourceFile codeFile() throws IOException
      Specified by:
      codeFile in interface org.aya.syntax.GenericAyaFile
      Throws:
      IOException

    • originalFile

      @NotNull public @NotNull org.aya.util.error.SourceFile originalFile() throws IOException
      Specified by:
      originalFile in interface org.aya.syntax.GenericAyaFile
      Throws:
      IOException

    • originalFile

      @NotNull public @NotNull org.aya.util.error.SourceFile originalFile(@NotNull @NotNull String sourceCode)

    • compiledCorePath

      @NotNull public @NotNull Path compiledCorePath()

    • toString

      public String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • equals

      public boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • hashCode

      public int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • owner

      @NotNull public @NotNull LibraryOwner owner()
      Returns the value of the owner record component.
      Returns:
      the value of the owner record component

    • underlyingFile

      @NotNull public @NotNull Path underlyingFile()
      Returns the value of the underlyingFile record component.
      Returns:
      the value of the underlyingFile record component

    • isLiterate

      public boolean isLiterate()
      Returns the value of the isLiterate record component.
      Returns:
      the value of the isLiterate record component

    • imports

      @NotNull public @NotNull kala.collection.mutable.MutableList<LibrarySource> imports()
      Returns the value of the imports record component.
      Returns:
      the value of the imports record component

    • program

      @NotNull public @NotNull kala.value.MutableValue<kala.collection.immutable.ImmutableSeq<org.aya.syntax.concrete.stmt.Stmt>> program()
      Returns the value of the program record component.
      Returns:
      the value of the program record component

    • tycked

      @NotNull public @NotNull kala.value.MutableValue<kala.collection.immutable.ImmutableSeq<org.aya.syntax.core.def.TyckDef>> tycked()
      Returns the value of the tycked record component.
      Returns:
      the value of the tycked record component

    • resolveInfo

      @NotNull public @NotNull kala.value.MutableValue<org.aya.resolve.ResolveInfo> resolveInfo()
      Returns the value of the resolveInfo record component.
      Returns:
      the value of the resolveInfo record component

    • literateData

      @NotNull public @NotNull kala.value.MutableValue<LiterateData> literateData()
      Returns the value of the literateData record component.
      Returns:
      the value of the literateData record component