Module aya.cli.impl

Package org.aya.cli.utils

Record Class LiterateData

java.lang.Object

java.lang.Record

org.aya.cli.utils.LiterateData

public record LiterateData(@NotNull org.aya.literate.Literate literate, @NotNull kala.collection.immutable.ImmutableSeq<org.aya.syntax.literate.AyaLiterate.AyaInlineCode> extractedExprs, @NotNull org.aya.util.error.SourceFile extractedAya)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	LiterateData.InjectedFrontMatter

Constructor Summary

Constructors

Constructor	Description
LiterateData(@NotNull org.aya.literate.Literate literate, @NotNull kala.collection.immutable.ImmutableSeq<org.aya.syntax.literate.AyaLiterate.AyaInlineCode> extractedExprs, @NotNull org.aya.util.error.SourceFile extractedAya)	Creates an instance of a LiterateData record class.

Method Summary

Modifier and Type	Method	Description
static @NotNull LiterateData	create(@NotNull org.aya.util.error.SourceFile mdFile, @NotNull org.aya.util.reporter.Reporter reporter)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NotNull org.aya.util.error.SourceFile	extractedAya()	Returns the value of the extractedAya record component.
@NotNull kala.collection.immutable.ImmutableSeq<org.aya.syntax.literate.AyaLiterate.AyaInlineCode>	extractedExprs()	Returns the value of the extractedExprs record component.
final int	hashCode()	Returns a hash code value for this object.
@NotNull org.aya.literate.Literate	literate()	Returns the value of the literate record component.
void	parseMe(@NotNull org.aya.syntax.GenericAyaParser parser)
void	resolve(@NotNull org.aya.resolve.ResolveInfo info)
static @Nullable org.aya.syntax.core.Jdg	simpleVar(org.aya.syntax.concrete.Expr expr)	Directly calling a def is usually an error due to the possible existence of implicit parameters.
static @NotNull org.aya.pretty.doc.Doc	toDoc(@NotNull org.aya.syntax.GenericAyaFile ayaFile, @Nullable org.aya.syntax.ref.ModulePath currentFileModule, @NotNull kala.collection.immutable.ImmutableSeq<org.aya.syntax.concrete.stmt.Stmt> program, @NotNull kala.collection.immutable.ImmutableSeq<org.aya.util.reporter.Problem> problems, @NotNull LiterateData.InjectedFrontMatter injected, @NotNull org.aya.util.prettier.PrettierOptions options)
final String	toString()	Returns a string representation of this record class.
void	tyck(@NotNull org.aya.resolve.ResolveInfo info)

Methods inherited from class java.lang.Object

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

Constructor Details

LiterateData

public LiterateData(@NotNull
 @NotNull org.aya.literate.Literate literate,
 @NotNull
 @NotNull kala.collection.immutable.ImmutableSeq<org.aya.syntax.literate.AyaLiterate.AyaInlineCode> extractedExprs,
 @NotNull
 @NotNull org.aya.util.error.SourceFile extractedAya)

Creates an instance of a LiterateData record class.

Parameters:

literate - the value for the literate record component

extractedExprs - the value for the extractedExprs record component

extractedAya - the value for the extractedAya record component

Method Details

create

@NotNull
public static @NotNull LiterateData create(@NotNull
 @NotNull org.aya.util.error.SourceFile mdFile,
 @NotNull
 @NotNull org.aya.util.reporter.Reporter reporter)

parseMe

public void parseMe(@NotNull
 @NotNull org.aya.syntax.GenericAyaParser parser)

resolve

public void resolve(@NotNull
 @NotNull org.aya.resolve.ResolveInfo info)

simpleVar

@Nullable
public static @Nullable org.aya.syntax.core.Jdg simpleVar(org.aya.syntax.concrete.Expr expr)

Directly calling a def is usually an error due to the possible existence of implicit parameters. However, when writing these functions in the REPL or a literate document, we are not usually asking for normalizing the function, instead we might just want to take a look at it, or check if it exists, or generate a link to it. So it's a good idea to not show an error message, and just pretty print the def instead.

tyck

public void tyck(@NotNull
 @NotNull org.aya.resolve.ResolveInfo info)

toDoc

@NotNull
public static @NotNull org.aya.pretty.doc.Doc toDoc(@NotNull
 @NotNull org.aya.syntax.GenericAyaFile ayaFile,
 @Nullable
 @Nullable org.aya.syntax.ref.ModulePath currentFileModule,
 @NotNull
 @NotNull kala.collection.immutable.ImmutableSeq<org.aya.syntax.concrete.stmt.Stmt> program,
 @NotNull
 @NotNull kala.collection.immutable.ImmutableSeq<org.aya.util.reporter.Problem> problems,
 @NotNull
 @NotNull LiterateData.InjectedFrontMatter injected,
 @NotNull
 @NotNull org.aya.util.prettier.PrettierOptions options)
                                             throws IOException

Throws:

IOException

toString

public final 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

hashCode

public final 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

equals

public final 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. All components in this record class are compared with Objects::equals(Object,Object).

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.

literate

@NotNull
public @NotNull org.aya.literate.Literate literate()

Returns the value of the literate record component.

Returns:

the value of the literate record component

extractedExprs

@NotNull
public @NotNull kala.collection.immutable.ImmutableSeq<org.aya.syntax.literate.AyaLiterate.AyaInlineCode> extractedExprs()

Returns the value of the extractedExprs record component.

Returns:

the value of the extractedExprs record component

extractedAya

@NotNull
public @NotNull org.aya.util.error.SourceFile extractedAya()

Returns the value of the extractedAya record component.

Returns:

the value of the extractedAya record component