All pages
Powered by GitBook
1 of 8

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

StringTable

Property in

Gets a dictionary mapping line IDs to StringInfo objects.

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.

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

Summary

Remarks

CompilationResult

CompilationResult

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

Name
Description

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

Gets the collection of objects for each node in .

Gets the collection of variable declarations that were found during compilation.

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

Gets the collection of file-level tags found in the source code.

Gets the compiled Yarn program that the produced.

Gets a dictionary mapping line IDs to StringInfo objects.

ContainsImplicitStringTags
DebugInfo
DebugInfo
Program
Declarations
Diagnostics
Diagnostic
FileTags
Program
Compiler
StringTable

Declarations

Property in

Gets the collection of variable declarations that were found during compilation.

This value will be null if the object's value was not or .

public IEnumerable<Declaration> Declarations { get; internal set; }

Summary

Remarks

CompilationResult
CompilationJob
CompilationType
DeclarationsOnly
FullCompilation

FileTags

Property in

Gets the collection of file-level tags found in the source code.

The keys of this dictionary are the file names (as indicated by the property of the 's collection), and the values are the file tags associated with that file.

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

Summary

Remarks

CompilationResult
FileName
CompilationJob
Files

Program

Property in

Gets the compiled Yarn program that the produced.

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

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

public Program Program { get; internal set; }

Summary

Remarks

CompilationResult
Compiler
Diagnostics
CompilationJob
CompilationType
FullCompilation

Diagnostics

Property in

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

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.

public IEnumerable<Diagnostic> Diagnostics { get; internal set; }

Summary

Remarks

CompilationResult
Diagnostic
CompilationResult
Program

DebugInfo

Property in

Gets the collection of objects for each node in .

public IReadOnlyDictionary<string, DebugInfo> DebugInfo { get; internal set; }

Summary

CompilationResult
DebugInfo
Program

ContainsImplicitStringTags

Property in

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

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.

public bool ContainsImplicitStringTags { get; internal set; }

Summary

Remarks

CompilationResult
AddTagsToLines(string,ICollection<string>)