Field in CompilationJob

Summary

The File structs that represent the content to parse..

public IEnumerable<File> Files;

Field in CompilationJob

Summary

The declarations for variables.

public IEnumerable<Declaration> VariableDeclarations;

Field in CompilationJob

Summary

The Library that contains declarations for functions.

public Library Library;

Struct in Yarn.Compiler

Inherits from System.ValueType

Summary

An object that contains Yarn source code to compile, and instructions on how to compile it.

public struct CompilationJob

Remarks

Instances of this struct are used with Compile(CompilationJob) to produce CompilationResult objects.

Enums

Fields

Methods

Structs

Method in CompilationJob

Summary

Creates a new CompilationJob using the contents of a string.

public static CompilationJob CreateFromString(string fileName, string source, Library library = null)

Parameters

Returns

A new CompilationJob .

Struct in

Inherits from System.ValueType

Summary

Represents the contents of a file to compile.

Fields

Field in

Summary

The name of the file.

Remarks

This may be a full path, or just the filename or anything in between. This is useful for diagnostics, and for attributing objects to their original source files.

Method in

Summary

Creates a new using the contents of a collection of files.

Parameters

Returns

A new .

Field in

Summary

The source code of this file.

Field in

Summary

The type of compilation to perform.

Struct in Yarn.Compiler

Inherits from System.ValueType

Summary

The result of a compilation.

public struct CompilationResult

Remarks

Instances of this struct are produced as a result of supplying a CompilationJob to Compile(CompilationJob) .

Properties

Enum in CompilationJob

Inherits from System.Enum

Summary

The type of compilation that the compiler will do.

public enum Type
{
    FullCompilation,
    DeclarationsOnly,
    StringsOnly
}

Members

Enumeration Member in

Summary

The compiler will derive only the variable and function declarations, and file tags, found in the script.

Enumeration Member in

Summary

The compiler will generate a string table only.

Property in

Summary

Gets the collection of objects that describe problems in the source code.

Remarks

If the compiler encounters errors while compiling source code, the it produces will have a value of null . To help figure out what the error is, users should consult the contents of this property.

Property in

Summary

Property in

Summary

Gets a value indicating whether the compiler had to create line IDs for lines in the source code that lacked #line: tags.

Remarks

Every line is required to have a line ID. If a line doesn't have a line ID specified in the source code (via a #line: tag), the compiler will create one.

Implicit line IDs are guaranteed to remain the same between compilations when the source file does not change. If you want line IDs to remain the same when the source code may be modified in the future, add a #line: tag to the line. This may be done by hand, or added using the method.

Property in CompilationResult

Summary

Gets the compiled Yarn program that the Compiler produced.

public Program Program { get; internal set; }

Remarks

This value will be null if there were errors in the compilation. If this is the case, Diagnostics will contain information describing the errors.

It will also be null if the CompilationJob object's CompilationType value was not FullCompilation.

Property in CompilationResult

Summary

Gets a dictionary mapping line IDs to StringInfo objects.

public IDictionary<string, StringInfo> StringTable { get; internal set; }

Remarks

The string table contains the extracted line text found in the provided source code. The keys of this dictionary are the line IDs for each line - either through explicit line tags indicated through the #line: tag, or implicitly-generated line IDs that the compiler added during compilation.

Property in CompilationResult

Summary

public Dictionary<string, IEnumerable<string>> FileTags { get; internal set; }

Class in Yarn.Compiler

Inherits from Yarn.Compiler.YarnSpinnerParserBaseListener

Summary

Compiles Yarn code.

public class Compiler : YarnSpinnerParserBaseListener

Methods

Method in

Summary

Parameters

Field in

Summary

The string used for if the Declaration was found outside of a Yarn source file.

Method in

Summary

Flattens a tree of Antlr4.Runtime.Tree.IParseTree objects by recursively visiting their children, and converting them into a flat System.Collections.Generic.IEnumerable`1 .

Parameters

Returns

An System.Collections.Generic.IEnumerable`1 that contains a flattened version of the hierarchy rooted at node .

Method in

Summary

Compiles Yarn code, as specified by a compilation job.

Parameters

Returns

The results of the compilation.

See Also

• : An object that contains Yarn source code to compile, and instructions on how to compile it.

• : The result of a compilation.

Method in Declaration

Summary

public override int GetHashCode()

Method in Declaration

Summary

public override string ToString()

Method in Compiler

Summary

Gets the text of the documentation comments that either immediately precede context , or are on the same line as context .

public static string GetDocumentComments(CommonTokenStream tokens, ParserRuleContext context, bool allowCommentsAfter = true)

Remarks

Documentation comments begin with a triple-slash ( /// ), and are used to describe variable declarations. If documentation comments precede a declaration (that is, they're not on the same line as the declaration), then they may span multiple lines, as long as each line begins with a triple-slash.

Parameters

Returns

The text of the documentation comments.

Method in Declaration

Summary

public override bool Equals(object obj)

Parameters

Method in Declaration

Summary

Creates a new instance of the Declaration class, using the given name and default value. The ReturnType of the new instance will be configured based on the type of defaultValue , and the DeclarationType will be Type.Variable . All other properties will be their default values.

public static Declaration CreateVariable(string name, Yarn.IType type, IConvertible defaultValue, string description = null)

Parameters

Returns

A new instance of the Declaration class.

Property in

Summary

Get or sets a value indicating whether this Declaration was implicitly inferred from usage.

Property in

Summary

Gets a string describing the purpose of this .

Constructor in

Summary

Property in

Summary

The line number at which this Declaration was found in the source file.

Remarks

If this was not found in a Yarn source file, this will be -1.

Property in

Summary

Gets the name of the node in which this Declaration was found.

Remarks

If this was not found in a Yarn source file, this will be null .

Property in

Summary

Gets the line number at which this Declaration was found in the node indicated by .

Remarks

If this was not found in a Yarn source file, this will be -1.

Property in

Summary

Gets the name of the file in which this Declaration was found.

Remarks

If this was not found in a Yarn source file, this will be .

Property in

Summary

Gets the name of this Declaration.

Field in

Summary

Field in Diagnostic

Summary

public string Message = "(internal error: no message provided)";

Class in Yarn.Compiler

Inherits from System.Object

Summary

public sealed class Diagnostic

Constructors

Enums

Fields

Methods

Constructor in

Summary

Parameters

Property in

Summary

Field in

Summary

Field in Diagnostic

Summary

public DiagnosticSeverity Severity = DiagnosticSeverity.Error;

Field in Diagnostic

Summary

public int Line;

Enumeration Member in DiagnosticSeverity

Summary

Error

Method in Diagnostic

Summary

public override int GetHashCode()

Constructor in Diagnostic

Summary

public Diagnostic(string fileName, ParserRuleContext context, string message, DiagnosticSeverity severity = DiagnosticSeverity.Error)

Parameters

Method in Diagnostic

Summary

public override bool Equals(object obj)

Parameters

Constructor in Diagnostic

Summary

public Diagnostic(string message, DiagnosticSeverity severity = DiagnosticSeverity.Error)

Parameters

Constructor in Diagnostic

Summary

public Diagnostic(string fileName, string message, DiagnosticSeverity severity = DiagnosticSeverity.Error)

Parameters

Struct in

Inherits from System.ValueType

Summary

Contains the result of parsing a single file of source code.

Remarks

This class provides only syntactic information about a parse - that is, it provides access to the parse tree, and the stream of tokens used to produce that parse tree.

Constructors

Methods

Properties

Property in

Summary

Gets the default value of this , if no value has been specified in code or is available from a 's .

Enumeration Member in DiagnosticSeverity

Summary

Warning

Method in Diagnostic

Summary

public override string ToString()

Enumeration Member in DiagnosticSeverity

Summary

Info

Constructor in FileParseResult

Summary

Initializes a new instance of the FileParseResult struct.

public FileParseResult(string name, IParseTree tree, CommonTokenStream tokens)

Parameters

Enum in Diagnostic

Inherits from System.Enum

Summary

public enum DiagnosticSeverity
{
    Error,
    Warning,
    Info
}

Members

Method in FileParseResult

Summary

public override bool Equals(object obj)

Parameters

Property in

Summary

The tokens extracted from the file.

Class in

Inherits from Antlr4.Runtime.Lexer

Summary

A Lexer subclass that detects newlines and generates indent and dedent tokens accordingly.

Constructors

Methods

Properties

Structs

Property in

Summary

Gets the collection of warnings determined during lexing.

Method in FileParseResult

Summary

public override int GetHashCode()

Struct in IndentAwareLexer

Inherits from System.ValueType

Summary

A warning emitted during lexing.

public struct Warning

Fields

Field in StringInfo

Summary

The name of the file this string was found in.

public string fileName;

Field in StringInfo

Summary

The line number at which this string was found in the file.

public int lineNumber;

Struct in Yarn.Compiler

Inherits from System.ValueType

Summary

Information about a string. Stored inside a string table, which is produced from the Compiler.

public struct StringInfo

Remarks

You do not create instances of this class yourself. They are generated by the Compiler .

Fields

Methods

Field in

Summary

The name of the node that this string was found in.

Property in

Summary

The parse tree extracted from the file.

Field in

Summary

The original text of the string.

Summary

Contains classes for compiling Yarn code.

Classes

Namespaces

Structs

Field in

Summary

The metadata (i.e. hashtags) associated with this string.

Remarks

This array will contain any hashtags associated with this string besides the #line: hashtag.

Method in StringInfo

Summary

public override string ToString()

Method in Utility

Summary

Given Yarn source code, adds line tags to the ends of all lines that need one and do not already have one.

public static string AddTagsToLines(string contents, ICollection<string> existingLineTags = null)

Remarks

This method ensures that it does not generate line tags that are already present in the file, or present in the existingLineTags collection.

Line tags are added to any line of source code that contains user-visible text: lines, options, and shortcut options.

Parameters

Returns

The modified source code, with line tags added.

Class in

Inherits from System.Object

Summary

Utility methods for working with line tags.

Methods

Constructor in

Summary

Initializes a new instance of the class.

Parameters

Method in

Summary

Parses a string of Yarn source code, and produces a FileParseResult and (if there were any problems) a collection of diagnostics.

Parameters

Returns

A tuple containing a that stores the parse tree and tokens, and a collection of objects that describe problems in the source code.

Field in

Summary

Indicates whether this string's line ID was implicitly generated.

Remarks

Implicitly generated line IDs are not guaranteed to remain the same across multiple compilations. To ensure that a line ID remains the same, you must define it by adding a line tag to the line.

Method in

Summary

Method in

Summary

Generates a Yarn script that contains a node that declares variables.

Remarks

This method is intended to be called by tools that let the user manage variable declarations. Such tools can read the existing variable declarations in from a script (by compiling the script with the value set to ), allow the user to make changes, and then write the changes to disk by calling this method and saving the results.

Parameters

Returns

A string containing a Yarn script that declares the specified variables.

Enumeration Member in

Summary

The compiler will do a full compilation, and generate a , function declaration set, and string table.

Field in

Summary

Method in

Summary

Creates a new using the contents of a collection of files.

Parameters

Returns

A new .

Class in

Inherits from System.Object

Summary

Constructors

Fields

Methods

Properties

Field in Warning

Summary

The token associated with the warning.

public IToken Token;

Field in Warning

Summary

The message associated with the warning.

public string Message;

Property in FileParseResult

Summary

The name of the file.

public string Name { get; }