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

Property in CompilationResult

Summary

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

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

Remarks

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

Property in CompilationResult

Summary

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

Property in CompilationResult

Summary

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

Property in

Summary

Gets the compiled Yarn program that the produced.

Remarks

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 .

Property in CompilationResult

Summary

Gets the collection of DebugInfo objects for each node in Program .

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

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

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

public bool ContainsImplicitStringTags { get; internal set; }

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 AddTagsToLines(string,ICollection<string>) method.