/// <summary>
/// Checks that a frame is correctly constructed.
/// </summary>
/// <param name="nodeType">Type of the node this frame can describe.</param>
/// <param name="nodeTemplateTable">Table of templates with all frames.</param>
/// <param name="commentFrameCount">Number of comment frames found so far.</param>
public override bool IsValid(Type nodeType, FrameTemplateReadOnlyDictionary nodeTemplateTable, ref int commentFrameCount)
{
bool IsValid = true;
IsValid &= base.IsValid(nodeType, nodeTemplateTable, ref commentFrameCount);
IsValid &= NodeTreeHelper.IsStringProperty(nodeType, PropertyName);
Debug.Assert(IsValid);
return(IsValid);
}
private protected virtual void BrowseChildrenOfNode(IReadOnlyBrowseContext browseNodeContext, INode node)
{
IList <string> PropertyNames = NodeTreeHelper.EnumChildNodeProperties(node);
foreach (string PropertyName in PropertyNames)
{
INode ChildNode;
Type ChildInterfaceType, ChildNodeType;
IReadOnlyList <INode> ChildNodeList;
IReadOnlyList <INodeTreeBlock> ChildBlockList;
bool IsHandled = false;
if (NodeTreeHelperChild.IsChildNodeProperty(node, PropertyName, out ChildNodeType))
{
NodeTreeHelperChild.GetChildNode(node, PropertyName, out ChildNode);
Debug.Assert(ChildNode != null);
IReadOnlyBrowsingPlaceholderNodeIndex ChildNodeIndex = CreateChildNodeIndex(browseNodeContext, node, PropertyName, ChildNode);
// Create a collection containing one index for this child node.
IReadOnlyIndexCollection IndexCollection = CreatePlaceholderIndexCollection(browseNodeContext, PropertyName, ChildNodeIndex);
browseNodeContext.AddIndexCollection(IndexCollection);
IsHandled = true;
}
else if (NodeTreeHelperOptional.IsOptionalChildNodeProperty(node, PropertyName, out ChildNodeType))
{
IReadOnlyBrowsingOptionalNodeIndex OptionalNodeIndex = CreateOptionalNodeIndex(browseNodeContext, node, PropertyName);
// Create a collection containing one index for this optional node.
IReadOnlyIndexCollection IndexCollection = CreateOptionalIndexCollection(browseNodeContext, PropertyName, OptionalNodeIndex);
browseNodeContext.AddIndexCollection(IndexCollection);
IsHandled = true;
}
else if (NodeTreeHelperList.IsNodeListProperty(node, PropertyName, out ChildNodeType))
{
NodeTreeHelperList.GetChildNodeList(node, PropertyName, out ChildNodeList);
Debug.Assert(ChildNodeList != null);
// Create a collection containing indexes for each children.
IReadOnlyIndexCollection IndexCollection = BrowseNodeList(browseNodeContext, node, PropertyName, ChildNodeList);
browseNodeContext.AddIndexCollection(IndexCollection);
IsHandled = true;
}
else if (NodeTreeHelperBlockList.IsBlockListProperty(node, PropertyName, out ChildInterfaceType, out ChildNodeType))
{
NodeTreeHelperBlockList.GetChildBlockList(node, PropertyName, out ChildBlockList);
Debug.Assert(ChildBlockList != null);
// Create a collection containing indexes for each child blocks and their children.
IReadOnlyIndexCollection IndexCollection = BrowseNodeBlockList(browseNodeContext, node, PropertyName, ChildBlockList);
browseNodeContext.AddIndexCollection(IndexCollection);
IsHandled = true;
}
else if (NodeTreeHelper.IsBooleanProperty(node, PropertyName))
{
browseNodeContext.AddValueProperty(PropertyName, ValuePropertyType.Boolean);
IsHandled = true;
}
else if (NodeTreeHelper.IsEnumProperty(node, PropertyName))
{
browseNodeContext.AddValueProperty(PropertyName, ValuePropertyType.Enum);
IsHandled = true;
}
else if (NodeTreeHelper.IsStringProperty(node, PropertyName))
{
browseNodeContext.AddValueProperty(PropertyName, ValuePropertyType.String);
IsHandled = true;
}
else if (NodeTreeHelper.IsGuidProperty(node, PropertyName))
{
browseNodeContext.AddValueProperty(PropertyName, ValuePropertyType.Guid);
IsHandled = true;
}
else if (NodeTreeHelper.IsDocumentProperty(node, PropertyName))
{
IsHandled = true; // Ignore the doc node.
}
Debug.Assert(IsHandled);
}
}
private protected virtual void SetNodeTypeToDefault(FrameTemplateDictionary dictionary, Type nodeType)
{
Debug.Assert(dictionary.ContainsKey(nodeType));
Debug.Assert(dictionary[nodeType] == null);
FrameHorizontalPanelFrame RootFrame = (FrameHorizontalPanelFrame)CreateHorizontalPanelFrame();
FrameNodeTemplate RootTemplate = (FrameNodeTemplate)CreateNodeTemplate();
RootTemplate.NodeType = nodeType;
RootTemplate.Root = RootFrame;
// Set the template, even if empty, in case the node recursively refers to itself (ex: expressions).
dictionary[nodeType] = RootTemplate;
RootFrame.Items.Add(CreateCommentFrame());
Type ChildNodeType;
IList <string> Properties = NodeTreeHelper.EnumChildNodeProperties(nodeType);
foreach (string PropertyName in Properties)
{
bool IsHandled = false;
if (NodeTreeHelperChild.IsChildNodeProperty(nodeType, PropertyName, out ChildNodeType))
{
FramePlaceholderFrame NewFrame = (FramePlaceholderFrame)CreatePlaceholderFrame();
NewFrame.PropertyName = PropertyName;
RootFrame.Items.Add(NewFrame);
IsHandled = true;
}
else if (NodeTreeHelperOptional.IsOptionalChildNodeProperty(nodeType, PropertyName, out ChildNodeType))
{
FrameOptionalFrame NewFrame = (FrameOptionalFrame)CreateOptionalFrame();
NewFrame.PropertyName = PropertyName;
RootFrame.Items.Add(NewFrame);
IsHandled = true;
}
else if (NodeTreeHelperList.IsNodeListProperty(nodeType, PropertyName, out Type ListNodeType))
{
FrameHorizontalListFrame NewFrame = (FrameHorizontalListFrame)CreateHorizontalListFrame();
NewFrame.PropertyName = PropertyName;
RootFrame.Items.Add(NewFrame);
IsHandled = true;
}
else if (NodeTreeHelperBlockList.IsBlockListProperty(nodeType, PropertyName, /*out Type ChildInterfaceType,*/ out Type ChildItemType))
{
FrameHorizontalBlockListFrame NewFrame = (FrameHorizontalBlockListFrame)CreateHorizontalBlockListFrame();
NewFrame.PropertyName = PropertyName;
RootFrame.Items.Add(NewFrame);
IsHandled = true;
}
else if (NodeTreeHelper.IsBooleanProperty(nodeType, PropertyName))
{
FrameDiscreteFrame NewDiscreteFrame = (FrameDiscreteFrame)CreateDiscreteFrame();
NewDiscreteFrame.PropertyName = PropertyName;
FrameKeywordFrame KeywordFalseFrame = (FrameKeywordFrame)CreateKeywordFrame();
KeywordFalseFrame.Text = $"{PropertyName}=False";
NewDiscreteFrame.Items.Add(KeywordFalseFrame);
FrameKeywordFrame KeywordTrueFrame = (FrameKeywordFrame)CreateKeywordFrame();
KeywordTrueFrame.Text = $"{PropertyName}=True";
NewDiscreteFrame.Items.Add(KeywordTrueFrame);
RootFrame.Items.Add(NewDiscreteFrame);
IsHandled = true;
}
else if (NodeTreeHelper.IsEnumProperty(nodeType, PropertyName))
{
NodeTreeHelper.GetEnumRange(nodeType, PropertyName, out int Min, out int Max);
FrameDiscreteFrame NewDiscreteFrame = (FrameDiscreteFrame)CreateDiscreteFrame();
NewDiscreteFrame.PropertyName = PropertyName;
for (int i = Min; i <= Max; i++)
{
FrameKeywordFrame KeywordFrame = (FrameKeywordFrame)CreateKeywordFrame();
KeywordFrame.Text = $"{PropertyName}={i}";
NewDiscreteFrame.Items.Add(KeywordFrame);
}
RootFrame.Items.Add(NewDiscreteFrame);
IsHandled = true;
}
else if (NodeTreeHelper.IsStringProperty(nodeType, PropertyName))
{
FrameTextValueFrame NewDiscreteFrame = (FrameTextValueFrame)CreateTextValueFrame();
NewDiscreteFrame.PropertyName = PropertyName;
RootFrame.Items.Add(NewDiscreteFrame);
IsHandled = true;
}
else if (NodeTreeHelper.IsGuidProperty(nodeType, PropertyName))
{
IsHandled = true;
}
else if (NodeTreeHelper.IsDocumentProperty(nodeType, PropertyName))
{
IsHandled = true;
}
Debug.Assert(IsHandled);
}
RootFrame.UpdateParent(RootTemplate, GetRoot());
}
