Compiler Members

NFX Class Library

[This is preliminary documentation and is subject to change.]

The Compiler type exposes the following members.

Constructors

	Name	Description
	Compiler	Initializes a new instance of the Compiler class

Methods

	Name	Description
	BuildNodeOutput	Override to perform custom interpretation per particular compiler target
	BuildOutputs	Override to perform compilation into output, the base implementation loops over all nodes and interprets script includes
	Compile
	Configure
	DoCompile	Performs a compilation - this is a root override-able method where compilation starts
	EnsureNotCompiled
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	EscapeFileName	Replaces incompatible characters for file names with "_"
	EscapeString
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetOutputFileSuffix	Override to provide meaningful extension for particular technology, i.e. SQL
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IncludeScriptFile	Performs a script file include
	IncludeScriptText	Performs a verbatim script text include
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Extension Methods

	Name	Description
	AsBool	(Defined by ObjectValueConversion.)
	AsByte	(Defined by ObjectValueConversion.)
	AsChar	(Defined by ObjectValueConversion.)
	AsDateTime	Overloaded. (Defined by ObjectValueConversion.)
	AsDateTime(DateTime, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsDecimal	(Defined by ObjectValueConversion.)
	AsDouble	(Defined by ObjectValueConversion.)
	AsEnum TEnum	(Defined by ObjectValueConversion.)
	AsFloat	(Defined by ObjectValueConversion.)
	AsGDID	Overloaded. (Defined by ObjectValueConversion.)
	AsGDID(GDID, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsGDIDSymbol	Overloaded. (Defined by ObjectValueConversion.)
	AsGDIDSymbol(GDIDSymbol, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsGUID	(Defined by ObjectValueConversion.)
	AsInt	(Defined by ObjectValueConversion.)
	AsJSONConfig	(Defined by ObjectValueConversion.)
	AsLaconicConfig	(Defined by ObjectValueConversion.)
	AsLong	(Defined by ObjectValueConversion.)
	AsNonNullOrEmptyString	(Defined by ObjectValueConversion.)
	AsNullableBool	(Defined by ObjectValueConversion.)
	AsNullableByte	(Defined by ObjectValueConversion.)
	AsNullableChar	(Defined by ObjectValueConversion.)
	AsNullableDateTime	(Defined by ObjectValueConversion.)
	AsNullableDecimal	(Defined by ObjectValueConversion.)
	AsNullableDouble	(Defined by ObjectValueConversion.)
	AsNullableEnum TEnum	(Defined by ObjectValueConversion.)
	AsNullableFloat	(Defined by ObjectValueConversion.)
	AsNullableGDID	(Defined by ObjectValueConversion.)
	AsNullableGDIDSymbol	(Defined by ObjectValueConversion.)
	AsNullableGUID	(Defined by ObjectValueConversion.)
	AsNullableInt	(Defined by ObjectValueConversion.)
	AsNullableLong	(Defined by ObjectValueConversion.)
	AsNullableSByte	(Defined by ObjectValueConversion.)
	AsNullableShort	(Defined by ObjectValueConversion.)
	AsNullableTimeSpan	(Defined by ObjectValueConversion.)
	AsNullableUInt	(Defined by ObjectValueConversion.)
	AsNullableULong	(Defined by ObjectValueConversion.)
	AsNullableUShort	(Defined by ObjectValueConversion.)
	AsSByte	(Defined by ObjectValueConversion.)
	AsShort	(Defined by ObjectValueConversion.)
	AsString	(Defined by ObjectValueConversion.)
	AsTimeSpan	Overloaded. (Defined by ObjectValueConversion.)
	AsTimeSpan(TimeSpan, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsUInt	(Defined by ObjectValueConversion.)
	AsULong	(Defined by ObjectValueConversion.)
	AsUri	(Defined by ObjectValueConversion.)
	AsUShort	(Defined by ObjectValueConversion.)
	AsXMLConfig	(Defined by ObjectValueConversion.)
	ToErlObject	Overloaded. Try to convert .NET native object type to corresponding Erlang term. Throw exception if conversion is not possible (Defined by ErlObject.)
	ToErlObject(ErlTypeOrder, Boolean)	Overloaded. Try to convert .NET native object type to corresponding Erlang term of given type. Throw exception if conversion is not possible (Defined by ErlObject.)
	ToJSON(JSONWritingOptions)	Overloaded. Serializes object into JSON string (Defined by JSONExtensions.)
	ToJSON(TextWriter, JSONWritingOptions)	Overloaded. Serializes object into JSON format using provided TextWriter (Defined by JSONExtensions.)
	ToJSON(Stream, JSONWritingOptions, Encoding)	Overloaded. Serializes object into JSON format using provided stream and optional encoding (Defined by JSONExtensions.)

Fields

	Name	Description
	m_CompileErrors
	SCRIPT_COMMENT_ATTR	Specifies the comment that will be output for decorated entity in the script
	SCRIPT_INCLUDE_SECTION	Specifies the name of the file to be included in the output verbatim, i.e.: script-include="mytypes.txt"{}
	SCRIPT_OUTPUT_NAME_ATTR	Specifies the name of the output that script text has to be placed in
	SCRIPT_TEXT_SECTION	Specifies the text to be included in the output verbatim, i.e.: script-text="INSERT INTO TBL_ABC VALUES(1, true, now())"{}

Properties

	Name	Description
	CompileErrors	Returns exception errors that were generated during compilation. This property returns "planned" errors that were caused by input, whereas CompileException returns exception that indicates some more drastic abnormality that broke the compilation
	CompileException	Returns exception that surfaced during compilation, or null if source has not compiled yet or no exception happened. This exception is different form CompileErrors because it indicates some un=planned condition that broke the compilation process
	HasCompiled	Returns true to indicate that compiler has already processed the source schema
	HasErrors	Returns true when this instance did not compile properly
	Name	Returns the name of the technology that this compiler targets. i.e. "ORACLE", "RecordModel"
	NameCaseSensitivity	Determines whether output script is case sensitive
	NameComparison	Returns string comparison options for names that depend on target case sensitivity
	OutputPath	Determines where compiled output is placed
	OutputPrefix	Determines the prefix for output names
	Schema	Returns source schema
	Target	Returns type of target that this instance produces output for