Method in CompilationResult

Summary

public string GetStringForKey(string key)

Parameters

Method in CompilationResult

Summary

public string GetDescriptionForVariable(string variableName)

Parameters

Method in CompilationResult

Summary

public IReadOnlyDictionary<int, string> GetLabelsForNode(string node)

Parameters

Property in CompilationResult

Summary

Gets a value indicating whether this compilation result contains any error diagnostics.

public bool ContainsErrors { get };

Remarks

If this value is true, then the value contained in Program will not contain a valid output.

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.

Class in Yarn.Compiler

Inherits from System.Object

Summary

The result of a compilation.

public class CompilationResult : ICodeDumpHelper

Remarks

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

Methods

Properties

Property in

Summary

Gets the collection of objects for each node in .

Property in

Summary

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

Remarks

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

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

Summary

Gets the debugging information for this compiled project.

Property in

Summary

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

Remarks

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.

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

Gets a collection of any types that were defined by the user in the input (for example, user-defined enum types.)

Property in

Summary

Gets a dictionary mapping line IDs to StringInfo objects.

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.