All pages
Powered by GitBook
1 of 15

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

DeclarationsOnly

Enumeration Member in

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

DeclarationsOnly

Summary

Type

CompilationJob

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

Name
Description
Name
Description
Name
Description
Name
Description

The type of compilation that the compiler will do.

The type of compilation to perform.

The structs that represent the content to parse..

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

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

Represents the contents of a file to compile.

Fields

Methods

Structs

The that contains declarations for functions.

The declarations for variables.

Creates a new using the contents of a string.

Type
CompilationType
Files
File
Library
CreateFromFiles(IEnumerable,Library)
CompilationJob
CreateFromFiles(string[])
CompilationJob
CreateFromString(string,string,Library)
File
Library
VariableDeclarations
CompilationJob

FullCompilation

Enumeration Member in Type

Summary

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

FullCompilation

CreateFromFiles(IEnumerable<string>,Library)

Method in CompilationJob

Summary

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

public static CompilationJob CreateFromFiles(IEnumerable<string> paths, Library library = null)

Parameters

Name
Description

System.Collections.Generic.IEnumerable<string> paths

The paths to the files.

A new .

library

The containing functions to use for this compilation.

Returns

CompilationJob

Library

Field in

The that contains declarations for functions.

Source

Field in

The source code of this file.

Yarn.Library
Library
public Library Library;

Summary

CompilationJob
Library
public string Source;

Summary

File

VariableDeclarations

Field in

The declarations for variables.

public IEnumerable<Declaration> VariableDeclarations;

Summary

CompilationJob

StringsOnly

Enumeration Member in

The compiler will generate a string table only.

StringsOnly

Summary

Type

FileName

Field in

The name of the file.

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.

public string FileName;

Summary

Remarks

File
Line

Type

Enum in CompilationJob

Inherits from System.Enum

Summary

The type of compilation that the compiler will do.

public enum Type
{
    FullCompilation,
    DeclarationsOnly,
    StringsOnly
}

Members

Name
Description

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

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

The compiler will generate a string table only.

DeclarationsOnly
FullCompilation
Program
StringsOnly

CreateFromFiles(string[])

Method in

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

Name
Description

A new .

string[] paths

The paths to the files.

Summary

Parameters

Returns

CompilationJob
CompilationJob
CompilationJob
public static CompilationJob CreateFromFiles(params string[] paths)

CompilationType

Field in

The type of compilation to perform.

public Type CompilationType;

Summary

CompilationJob

CreateFromString(string,string,Library)

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

Name
Description

string fileName

The name to assign to the compiled file.

A new .

string source

The text to compile.

library

Library of function definitions to use during compilation.

Returns

CompilationJob
Yarn.Library

File

Struct in CompilationJob

Inherits from System.ValueType

Summary

Represents the contents of a file to compile.

public struct File

Fields

Name
Description

The name of the file.

The source code of this file.

FileName
Source

Files

Field in

The structs that represent the content to parse..

public IEnumerable<File> Files;

Summary

CompilationJob
File