Resolving Symbolic References in a CodeDOM (Part 7)

// The Nova Project by Ken Beckett.
// Copyright (C) 2007-2012 Inevitable Software, all rights reserved.
// Released under the Common Development and Distribution License, CDDL-1.0: http://opensource.org/licenses/cddl1.php

using System.Collections.Generic;
using System.Windows;

using Nova.CodeDOM;

namespace Nova.UI
{
    /// <summary>
    /// The view model for a <see cref="CodeDOM.TypeDecl"/>.
    /// </summary>
    public abstract class TypeDeclVM : BlockStatementVM
    {
        #region /* FIELDS */

        protected ChildListVM<TypeParameterVM> _typeParameterVMs;        // Not used for EnumDecls
        protected ChildListVM<ConstraintClauseVM> _constraintClauseVMs;  // Not used for EnumDecls

        /// <summary>
        /// The generated WPF UI object to be highlighted for selections.
        /// </summary>
        public FrameworkElement SelectionElement;

        #endregion

        #region /* CONSTRUCTORS */

        /// <summary>
        /// Create a view model instance for the specified <see cref="CodeDOM.TypeDecl"/>.
        /// </summary>
        protected TypeDeclVM(TypeDecl typeDecl, bool isDescription, Dictionary<CodeObject, CodeObjectVM> dictionary)
            : base(typeDecl, isDescription, dictionary)
        {
            _typeParameterVMs = CreateListVM<TypeParameter, TypeParameterVM>(typeDecl.TypeParameters, dictionary);
            _constraintClauseVMs = CreateListVM<ConstraintClause, ConstraintClauseVM>(typeDecl.ConstraintClauses, dictionary);
        }

        #endregion

        #region /* PROPERTIES */

        /// <summary>
        /// The underlying <see cref="CodeDOM.TypeDecl"/> model.
        /// </summary>
        public TypeDecl TypeDecl
        {
            get { return (TypeDecl)CodeObject; }
        }

        /// <summary>
        /// A collection of optional <see cref="TypeParameterVM"/>s (for generic types).
        /// </summary>
        public ChildListVM<TypeParameterVM> TypeParameterVMs
        {
            get { return _typeParameterVMs; }
        }

        /// <summary>
        /// True if the type has <see cref="TypeParameterVM"/>s.
        /// </summary>
        public bool HasTypeParameterVMs
        {
            get { return (_typeParameterVMs != null && _typeParameterVMs.Count > 0); }
        }

        /// <summary>
        /// The number of <see cref="TypeParameterVM"/>s the type has.
        /// </summary>
        public int TypeParameterVMCount
        {
            get { return (_typeParameterVMs != null ? _typeParameterVMs.Count : 0); }
        }

        /// <summary>
        /// A collection of optional <see cref="ConstraintClauseVM"/>s (for generic types).
        /// </summary>
        public ChildListVM<ConstraintClauseVM> ConstraintClauseVMs
        {
            get { return _constraintClauseVMs; }
        }

        /// <summary>
        /// True if there are any <see cref="ConstraintClauseVM"/>s.
        /// </summary>
        public bool HasConstraintClauseVMs
        {
            get { return (_constraintClauseVMs != null && _constraintClauseVMs.Count > 0); }
        }

        #endregion

        #region /* METHODS */

        #endregion

        #region /* RENDERING */

        public override int BorderHPad
        {
            get { return 3; }
        }

        public override int BorderVPad
        {
            get { return 3; }
        }

        protected override void RenderPrefix(CodeRenderer renderer, RenderFlags flags)
        {
            renderer.RenderText(ModifiersHelpers.AsString(TypeDecl.Modifiers), KEYWORD_BRUSH, this);
        }

        protected override void RenderArgument(CodeRenderer renderer, RenderFlags flags)
        {
            RenderName(renderer, flags);
        }

        public void RenderName(CodeRenderer renderer, RenderFlags flags)
        {
            if (flags.HasFlag(RenderFlags.Description) && ParentVM is TypeDeclVM)
            {
                ((TypeDeclVM)ParentVM).RenderName(renderer, flags);
                DotVM.RenderDot(renderer, this);
            }
            RenderFlags passFlags = (flags & (RenderFlags.PassMask & ~(RenderFlags.Description | RenderFlags.ShowParentTypes)));
            if (!flags.HasFlag(RenderFlags.Description))
                SelectionElement = renderer.RenderText(TypeDecl.Name, TYPE_BRUSH, this);
            else
                renderer.RenderText(TypeDecl.Name, TYPE_BRUSH, this);
            if (HasTypeParameterVMs)
                TypeParameterVM.RenderTypeParameters(renderer, _typeParameterVMs, passFlags);
        }

        protected override void RenderSuffix(CodeRenderer renderer, RenderFlags flags)
        {
            if (!HasConstraintClauseVMs && !flags.HasFlag(RenderFlags.Description))
                RenderTerminator(renderer, flags);
        }

        protected override void RenderAfter(CodeRenderer renderer, RenderFlags flags)
        {
            ConstraintClauseVM.RenderConstraints(renderer, _constraintClauseVMs, flags | RenderFlags.HasTerminator);
            base.RenderAfter(renderer, flags);
        }

        public override void UnRender()
        {
            ChildListHelpers.UnRender(_typeParameterVMs);
            ChildListHelpers.UnRender(_constraintClauseVMs);
            base.UnRender();
        }

        /// <summary>
        /// Get the <see cref="FrameworkElement"/> to be highlighted when the object is selected.
        /// </summary>
        public override FrameworkElement GetSelectionElement()
        {
            return (SelectionElement ?? FrameworkElement);
        }

        #endregion
    }
}