Deconstruction Class

Represents a group of local variable declarations that are initialized from a tuple.

Inheritance Hierarchy

SystemObject
  Nova.CodeDOMCodeObject
    Nova.CodeDOMStatement
      Nova.CodeDOMVariableDecl
        Nova.CodeDOMLocalDecl
          Nova.CodeDOMMultiLocalDecl
            Nova.CodeDOMDeconstruction

Namespace: Nova.CodeDOM
Assembly: Nova.CodeDOM (in Nova.CodeDOM.dll) Version: 7.44.8391.13415

Syntax

Copy

public class Deconstruction : MultiLocalDecl

The Deconstruction type exposes the following members.

Constructors

	Name	Description
	Deconstruction(String)	Create a Deconstruction from an array of names.
	Deconstruction(LocalDecl)	Create a Deconstruction from an array of LocalDecls.
	Deconstruction(Expression, String)	Create a Deconstruction from a Type and array of names.
	Deconstruction(Parser, CodeObject, ParseFlags)	Parse a Deconstruction.

Top

Properties

	Name	Description
	_AsString	This property is just to make debugging easier. (Inherited from CodeObject.)
	Annotations	Annotations (comments, attributes, directives, messages) associated with the current code object. (Inherited from CodeObject.)
	Category	The descriptive category of the code object. (Inherited from LocalDecl.)
	ColumnNumber	The column number associated with the Deconstruction. (Overrides MultiLocalDeclColumnNumber.)
	Comment	The comment for the code object (if any). (Inherited from CodeObject.)
	Count	The number of LocalDecls. (Inherited from MultiLocalDecl.)
	DocComment	The documentation comment for the code object (if any). (Inherited from CodeObject.)
	EOLComment	The End-Of-Line comment for the code object (if any). (Inherited from CodeObject.)
	HasAnnotations	True if the code object has any annotations. (Inherited from CodeObject.)
	HasArgument	Always true for this type. (Overrides VariableDeclHasArgument.)
	HasArgumentParens	Always true for this type. (Overrides VariableDeclHasArgumentParens.)
	HasAttributes	True if the code object has any attributes. (Inherited from CodeObject.)
	HasComments	True if the code object has any comments of any kind. (Inherited from CodeObject.)
	HasCompilerDirectives	True if the code object has any compiler directive annotations. (Inherited from CodeObject.)
	HasDocComments	True if the code object has any documentation comments. (Inherited from CodeObject.)
	HasEOLComments	True if the code object has any EOL comments. (Inherited from CodeObject.)
	HasEOLOrPostAnnotations	True if the code object has any EOL or Postfix annotations. (Inherited from CodeObject.)
	HasErrors	True if the code object has any error messages. (Inherited from CodeObject.)
	HasFirstOnLineAnnotations	True if the code object has any annotations on separate lines. (Inherited from CodeObject.)
	HasInferredType	True if the variable has an inferred ('var') type. (Inherited from VariableDecl.)
	HasInfixComments	True if the code object has any Infix comments. (Inherited from CodeObject.)
	HasInitialization	True if the variable has an initialization Expression. (Inherited from VariableDecl.)
	HasMessages	True if the code object has any generated messages. (Inherited from CodeObject.)
	HasNoIndentation	Determines if the code object has no indentation. (Inherited from CodeObject.)
	HasNonEOLComments	True if the code object has any regular (non-doc) preceding (non-EOL, non-Infix, non-Postfix) comments. (Inherited from CodeObject.)
	HasPostAnnotations	True if the code object has any postfix annotations. (Inherited from CodeObject.)
	HasSharedType	True if the Deconstruction has a single shared 'var' type for all local variables, or False if each local variable declares its own type. (Overrides MultiLocalDeclHasSharedType.)
	HasTerminator	Determines if the code object has a terminator character. (Inherited from LocalDecl.)
	HasTerminatorDefault	True if the Statement has a terminator character by default. (Inherited from VariableDecl.)
	HiddenRef	The hidden MethodRef (or UnresolvedRef) that represents the Deconstruct() method being called if the type being deconstructed isn't a tuple type. (Overrides CodeObjectHiddenRef.)
	InfixComment	The infix comment for the code object (if any). (Inherited from CodeObject.)
	Initialization	An optional initialization Expression. (Inherited from VariableDecl.)
	IsConst	True if the local variable is const. (Inherited from LocalDecl.)
	IsDiscard	Return True if the LocalDecl is a discard variable. (Inherited from LocalDecl.)
	IsEndFirstOnLine	True if the closing paren or bracket is on a new line. (Inherited from Statement.)
	IsFirstOnLine	Determines if the code object appears as the first item on a line. (Inherited from CodeObject.)
	IsFirstOnLineDefault	True if the code object defaults to starting on a new line. (Inherited from CodeObject.)
	IsGenerated	Determines if the code object is generated. (Inherited from CodeObject.)
	IsGroupingSet	Determines if the 'grouping' (has parens or braces) status has been set. (Inherited from CodeObject.)
	IsNewLinesSet	Determines if the newline count has been set on the code object. (Inherited from CodeObject.)
	IsReadOnly	True if the local variable is readonly. (Inherited from LocalDecl.)
	IsRef	True if the local variable is a ref. (Inherited from LocalDecl.)
	IsRenderable	True if the CodeObject is renderable. (Inherited from CodeObject.)
	IsSingleLine	Determines if the code object only requires a single line for display. (Inherited from MultiLocalDecl.)
	IsSingleLineDefault	True if the code object only requires a single line for display by default. (Inherited from MultiLocalDecl.)
	IsStatic	Always false for a local variable. (Inherited from LocalDecl.)
	Item	Get the LocalDecl at the specified index. (Inherited from MultiLocalDecl.)
	Keyword	The keyword associated with the Statement (null if none). (Inherited from Statement.)
	LineNumber	The line number associated with the Deconstruction. (Overrides MultiLocalDeclLineNumber.)
	LocalDecls	The list of LocalDecls. (Inherited from MultiLocalDecl.)
	Modifiers	Optional Modifiers. (Overrides MultiLocalDeclModifiers.)
	Name	The name of the variable. (Inherited from VariableDecl.)
	NewLines	The number of newlines preceding the object (0 to N). (Inherited from Statement.)
	Parent	The parent CodeObject. (Inherited from CodeObject.)
	PostfixComment	The postfix comment for the code object (if any). (Inherited from CodeObject.)
	Terminator	The terminator character for the Statement. (Inherited from Statement.)
	Type	The type of the MultiLocalDecl. (Inherited from MultiLocalDecl.)

Top

Methods

	Name	Description
	Accept	Accept the specified visitor object for the current code object and it's children. (Overrides MultiLocalDeclAccept(IVisitor).)
	AcceptAnnotations(IVisitor)	Accept the specified visitor object for all regular (non-EOL, non-Infix, non-Postfix) annotations (comments, attributes, compiler directives). (Inherited from CodeObject.)
	AcceptAnnotations(IVisitor, AnnotationFlags)	Accept the specified visitor object for all specified Infix or Postfix annotations (comments, compiler directives). (Inherited from CodeObject.)
	AcceptEOLComments	Accept the specified visitor object for all EOL comments. (Inherited from CodeObject.)
	AcceptInfixComments	Accept the specified visitor object for all Infix comments. (Inherited from CodeObject.)
	AcceptInfixEOLComments	Accept the specified visitor object for all Infix EOL comments. (Inherited from CodeObject.)
	Add(LocalDecl)	Add a LocalDecl. (Overrides MultiLocalDeclAdd(LocalDecl).)
	Add(LocalDecl)	Add multiple LocalDecls. (Inherited from MultiLocalDecl.)
	Add(String, Expression)	Add a new LocalDecl with the specified name and optional type. (Overrides MultiLocalDeclAdd(String, Expression).)
	AddInternal	(Inherited from MultiLocalDecl.)
	AddRange	Add a collection of LocalDecls. (Inherited from MultiLocalDecl.)
	AddToDictionary	Add the CodeObject to the specified dictionary. (Inherited from MultiLocalDecl.)
	AssociateCommentWhenParsing	Determine if the specified comment should be associated with the current code object during parsing. (Inherited from Statement.)
	AsString	Render the entire code object as a string, using LFs for newlines. (Inherited from CodeObject.)
	AsText	Convert the code object to text with a trailing newline, and using CR/LF pairs for newlines (file format). (Inherited from CodeObject.)
	AsText(CodeWriter, CodeObjectRenderFlags)	(Inherited from Statement.)
	AsText(CodeObjectRenderFlags, Boolean, StackCodeWriterAlignmentState)	Convert the code object to text using the specified flags and format (file or string). (Inherited from CodeObject.)
	AsTextAfter	(Inherited from Statement.)
	AsTextAnnotations(CodeWriter, CodeObjectRenderFlags)	Render all regular (non-EOL, non-Infix, non-Postfix, non-Message) annotations (comments, attributes, compiler directives). (Inherited from CodeObject.)
	AsTextAnnotations(CodeWriter, AnnotationFlags, CodeObjectRenderFlags)	Render all specified Infix or Postfix annotations (comments, compiler directives). (Inherited from CodeObject.)
	AsTextArgument	(Overrides StatementAsTextArgument(CodeWriter, CodeObjectRenderFlags).)
	AsTextArgumentPrefix	(Overrides StatementAsTextArgumentPrefix(CodeWriter, CodeObjectRenderFlags).)
	AsTextBefore	(Inherited from CodeObject.)
	AsTextConstantValue	(Inherited from VariableDecl.)
	AsTextEOLComments	Render all EOL comments. (Inherited from CodeObject.)
	AsTextEvaluatedType	(Inherited from CodeObject.)
	AsTextInfixComments	Render all Infix comments with the specified mask. (Inherited from CodeObject.)
	AsTextInfixEOLComments	Render all Infix EOL comments. (Inherited from CodeObject.)
	AsTextInitialization	(Inherited from VariableDecl.)
	AsTextLeftMostAnnotations	Render all regular annotations on the current object, or the left most binary operator. (Inherited from CodeObject.)
	AsTextLength	Determine the length of the code object if converted to a string using the specified flags. (Inherited from CodeObject.)
	AsTextPrefix	(Overrides MultiLocalDeclAsTextPrefix(CodeWriter, CodeObjectRenderFlags).)
	AsTextStatement	(Overrides MultiLocalDeclAsTextStatement(CodeWriter, CodeObjectRenderFlags).)
	AsTextSuffix	(Overrides MultiLocalDeclAsTextSuffix(CodeWriter, CodeObjectRenderFlags).)
	AsTextTerminator	(Inherited from Statement.)
	AsTextType	(Inherited from VariableDecl.)
	AttachAnnotation(Annotation, Boolean)	Attach an Annotation (Comment, DocComment, Attribute, CompilerDirective, or Message) to the CodeObject. (Inherited from CodeObject.)
	AttachAnnotation(Annotation, AnnotationFlags, Boolean)	Attach an Annotation to the CodeObject at the specified position. (Inherited from CodeObject.)
	AttachComment	Create a comment object and attach it to the code object. (Inherited from CodeObject.)
	AttachEOLComment	Create an EOL comment object and attach it to the code object. (Inherited from CodeObject.)
	AttachMessage	Create a message and attach it to the code object. (Inherited from CodeObject.)
	CalculateMetrics	Calculate metrics for this code object and its children. (Inherited from CodeObject.)
	CheckForAlignment	Check for alignment of any EOL comments. (Inherited from CodeObject.)
	Clone	Deep-clone the code object. (Overrides MultiLocalDeclClone.)
	CloneField(Object, Object)	Clone a field of a code object, including setting the parent. (Inherited from CodeObject.)
	CloneFieldT(T, T)	Clone a field of a code object, including setting the parent. (Inherited from CodeObject.)
	CopyFormatting	Copy formatting from another code object. (Inherited from CodeObject.)
	CreateAnnotations	Create the list of child Annotations, or return the existing one. (Inherited from CodeObject.)
	CreateRef	This method isn't supported for this type. (Inherited from MultiLocalDecl.)
	DefaultFormat	Default format the code object. (Inherited from CodeObject.)
	DefaultFormatField	(Inherited from Statement.)
	DefaultNewLines	Determine a default of 1 or 2 newlines when adding items to a Block. (Inherited from CodeObject.)
	Dispose	Dispose the CodeObject. (Inherited from CodeObject.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	EvaluateType	Evaluate the type of the LocalDecl. (Inherited from LocalDecl.)
	EvaluateTypeOrNamespace	Evaluate the type or namespace associated with the code object. (Inherited from CodeObject.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FindParentT	Find the parent object of the specified type. (Inherited from CodeObject.)
	FindParentMethod	Find the parent method (or anonymous method or lambda) of the current code object. (Inherited from CodeObject.)
	FindParentMethodOrType	Find the parent method (or anonymous method or lambda) or type of the current code object. (Inherited from CodeObject.)
	GetAllChildrenT	Get an enumerator for all children objects of type T in the CodeObject and in any child CodeObjects (recursively). (Inherited from CodeObject.)
	GetAttribute	Returns the first attribute expression (Call or ConstructorRef) with the specified name on the CodeObject. (Inherited from CodeObject.)
	GetComment	Get the comment that satisfies the specified predicate. (Inherited from CodeObject.)
	GetDeconstructionType	Get the type being deconstructed (the type of the initialization expression, or the collection element type if used in a ForEach).
	GetDescription	Get a short text description of the CodeObject. This is generally the shortest text representation that uniquely identifies objects, even if they have the same name, for example: type or return type, name, type parameters, parameters. (Inherited from CodeObject.)
	GetDocSummary	Returns the DocSummary documentation comment, or null if none exists. (Inherited from CodeObject.)
	GetEnumerator	Enumerate the child FieldDecls. (Inherited from MultiLocalDecl.)
	GetFullName	Get the full name of the VariableDecl, including the namespace name (if any). (Inherited from VariableDecl.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetIndentLevel	Get the indent level of this object. (Inherited from CodeObject.)
	GetIndentSpaceCount	Get the current indent in spaces. (Inherited from CodeObject.)
	GetInferredType	Determine the type of an inferred ('var') type. (Overrides MultiLocalDeclGetInferredType(VarTypeRef).)
	GetNamespace	Get the Namespace for this CodeObject. (Inherited from CodeObject.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetTypeOfChildAtIndex	Get the type of the child local variable declaration with the specified index.
	GetTypeRef	Get a TypeRef for the type with the specified full name, with caching (generally used for System types). (Inherited from CodeObject.)
	GetValue	Get the constant value of the variable (if any). (Inherited from VariableDecl.)
	GetWorstMessageType	Get the type of the worst attached message. (Inherited from CodeObject.)
	HasAnnotationT	(Inherited from CodeObject.)
	HasAttribute	Returns true if the attribute with the specified name exists on the object, otherwise false. (Inherited from CodeObject.)
	HasUnresolvedRef	Returns true if the code object is an UnresolvedRef or has any UnresolvedRef children. (Inherited from MultiLocalDecl.)
	IsChildIndented	Returns true if the specified child object is indented from the parent. (Inherited from CodeObject.)
	IsChildPrefix	Returns true if the specified child object is prefixed to the current object. (Inherited from CodeObject.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MoveAllComments	Move all (regular or EOL) comments from the specified token to the current code object, converting any EOL comments to regular comments (which will be rendered inline if necessary). (Inherited from CodeObject.)
	MoveAnnotations	Move any annotations from the specified location to the specified destination location. (Inherited from CodeObject.)
	MoveComments(Token)	Move any non-EOL comments from the specified token to the current code object. (Inherited from CodeObject.)
	MoveComments(Token, Boolean)	Move any non-EOL comments from the specified token to the current code object. (Inherited from CodeObject.)
	MoveCommentsAsPost	Move any non-EOL comments from the specified token to the current code object as Post comments. (Inherited from CodeObject.)
	MoveEOLAndPostAnnotations	Move any EOL or Postfix annotations from the specified code object to the current code object. (Inherited from CodeObject.)
	MoveEOLComment(CodeObject)	Move any EOL comment from the specified code object to the current code object. (Inherited from CodeObject.)
	MoveEOLComment(Token)	Move any EOL comment from the specified token to the current code object. (Inherited from CodeObject.)
	MoveEOLComment(Token, Boolean, Boolean)	Move any EOL comment from the specified token to the current code object. (Inherited from CodeObject.)
	MoveEOLCommentAsInfix	Move any EOL comment from the specified token to the current code object as an Infix EOL comment. (Inherited from CodeObject.)
	MoveFormatting(CodeObject)	Move formatting from the specified code object to the current object. (Inherited from CodeObject.)
	MoveFormatting(Token)	Move formatting from the specified token to the current object. (Inherited from CodeObject.)
	MoveLocationAndComment	Move NewLines, LineNumber, Column, and any EOL comment from the specified Token. (Inherited from VariableDecl.)
	MovePrefixAnnotationsAs	Move any prefix annotations on the specified code object to the current code object as the specified type of annotation. (Inherited from CodeObject.)
	NotifyListedAnnotationAdded	Propagate the listed annotation to the parent CodeUnit and above. (Inherited from CodeObject.)
	NotifyListedAnnotationRemoved	Remove the listed annotation from the parent CodeUnit and above. (Inherited from CodeObject.)
	Parse	Parse a Deconstruction.
	ParseAnnotations(Parser, CodeObject)	Parse annotations - specifically, compiler directives around things such as TypeParameters or ParameterDecls. (Inherited from CodeObject.)
	ParseAnnotations(Parser, CodeObject, Boolean, Boolean)	Parse any comments, attributes, compiler directives. (Inherited from CodeObject.)
	ParseExpectedToken	Parse the specified expected token, attaching a parse error to the current object if it doesn't exist. (Inherited from CodeObject.)
	ParseInitialization	Parse the initialization (if any). (Inherited from VariableDecl.)
	ParseKeywordAndArgument	(Inherited from Statement.)
	ParseName(Parser, CodeObject)	(Inherited from LocalDecl.)
	ParseName(Parser, String)	(Inherited from VariableDecl.)
	ParseTerminator	Parse the terminator at the end of a Statement. (Inherited from Statement.)
	ParseType	This method is used when parsing forwards starting with the type is possible. (Inherited from VariableDecl.)
	ParseUnusedAnnotations	Parse annotations from the Unused list. (Inherited from CodeObject.)
	ParseUnusedType	This method is used when we must parse backwards through the Unused list to get a type. (Inherited from Statement.)
	PeekDeconstruction	Peek ahead at the input tokens to determine if they look like a valid Deconstruction.
	RemoveAllAnnotationsT	Remove all annotations of the specified type from this object. (Inherited from CodeObject.)
	RemoveAllAnnotationsWhereT	Remove all annotations from this object where the specified predicate is true. (Inherited from CodeObject.)
	RemoveAllMessages	Remove all messages from this object, or optionally only from the specified source. (Inherited from CodeObject.)
	RemoveAttribute	Remove the attribute expression with the specified name. (Inherited from CodeObject.)
	RemoveFromDictionary	Remove the CodeObject from the specified dictionary. (Inherited from MultiLocalDecl.)
	Resolve(ResolveFlags)	Resolve all child symbolic references. (Inherited from CodeObject.)
	Resolve(ResolveCategory, ResolveFlags)	Resolve all child symbolic references, using the specified ResolveCategory and ResolveFlags. (Overrides MultiLocalDeclResolve(ResolveCategory, ResolveFlags).)
	ResolveAttributes	Resolve any attached attributes. (Inherited from CodeObject.)
	ResolveDocComments	Resolve any references in attached documentation comments. (Inherited from CodeObject.)
	ResolveGotoTargetUp	Resolve child code objects that match the specified name are valid goto targets, moving up the tree until a complete match is found. (Inherited from CodeObject.)
	ResolveRef	Resolve child code objects that match the specified name. (Inherited from MultiLocalDecl.)
	ResolveRefUp	Resolve child code objects that match the specified name, moving up the tree until a complete match is found. (Inherited from CodeObject.)
	ResolveRefUpSkipMethodBody	Similar to ResolveRefUp(String, Resolver), but skips trying to resolve the symbol in the body or parameters of a method (used for resolving parameter types). (Inherited from CodeObject.)
	SetField(Object, Object, Boolean)	Set a field of a code object, including setting the parent, and optional formatting. (Inherited from CodeObject.)
	SetFieldT(ChildListT, ChildListT)	Set a ChildList collection field of a code object, including setting the parent. (Inherited from CodeObject.)
	SetFieldT(T, T, Boolean)	Set a field of a code object, including setting the parent, and optional formatting. (Inherited from CodeObject.)
	SetFormatFlag	(Inherited from CodeObject.)
	SetLineCol(CodeObject)	Set the line and column numbers to those in the specified CodeObject. (Inherited from CodeObject.)
	SetLineCol(Token)	Set the line and column numbers to those in the specified token. (Inherited from CodeObject.)
	SetNewLines	Special method to set the newline count without setting the NewLinesSet flag. (Inherited from CodeObject.)
	SetStartLineCol	Set the starting line and column numbers to those in the specified token (used by some code objects with prefixes such as modifiers). (Inherited from CodeObject.)
	SetTypeFromParentMulti	(Inherited from LocalDecl.)
	ToString	Render the type of the code object and its description as a string. (Inherited from CodeObject.)
	UpdateAllDeclExpressions	Recursively update the dictionary of names in the specified Block by either adding or removing (as specified by the 2nd parameter) all appropriate nested INamedCodeObjects expressions in the current CodeObject tree (specifically implemented for LocalDeclExpr expression objects). (Inherited from VariableDecl.)
	UpdateLineCol	Update the line and column numbers according to the current positions in the CodeWriter, if the UpdateLineCol flag is set. (Inherited from CodeObject.)

Top

Fields

	Name	Description
	_annotations	Any Annotations (Comments, DocComments, Attributes, or Messages) associated with the CodeObject (null if none). (Inherited from CodeObject.)
	_columnNumber	The starting column number associated with the CodeObject if parsed from or written to text form. (Inherited from CodeObject.)
	_deconstructMethodRef
	_formatFlags	Formatting flags - for line feeds, braces, etc. (Inherited from CodeObject.)
	_initialization	(Inherited from VariableDecl.)
	_lineNumber	The starting line number associated with the CodeObject if parsed from or written to text form. (Inherited from CodeObject.)
	_localDecls	(Inherited from MultiLocalDecl.)
	_modifiers	(Inherited from LocalDecl.)
	_name	(Inherited from VariableDecl.)
	_parent	The parent CodeObject. (Inherited from CodeObject.)
	_type	(Inherited from VariableDecl.)
	ParseTokenEnd	The token used to parse the end of the arguments.
	ParseTokenSeparator	The token used to separate LocalDecls in the Deconstruction.
	ParseTokenStart	The token used to parse the start of the arguments.

Top

Remarks

The Deconstruction can either have a Type for each LocalDecl (in which case it's own Type will be null), or a single Type for all of them (in which case each individual LocalDecl will always have a matching Type). The LocalDecls can't have their own Initialization members, while the Initialization of the Desconstruction should always be a TupleRef with a number of fields matching the number of LocalDecls, and it's Name will be null. LocalDecls can be omitted using the Discard syntax of "_", which will be stored as a null object. No Modifiers are legal on the Deconstruction or the LocalDecls. If the LocalDecls are sharing the Type of the MultiLocalDecl, then any change to it is propagated to all of the LocalDecls, and trying to change the Type of a LocalDecl will throw an exception. Possible formats: (type1 name1, type2 name2...) = var (name1, _, name3...) = for ([either of above] in [collection/array of tuples]) NOTE: The format '(expr1, expr2...) = ' is also a legal type of deconstruction, but it's handled by the DeconstructionExpr class, because it's an Expression and NOT a Statement or a variable declaration.

Reference

Nova.CodeDOM Namespace