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.Collections.Specialized;

using Nova.CodeDOM;
using Nova.Utilities;

namespace Nova.UI
{
    /// <summary>
    /// The view model for a <see cref="CodeDOM.Solution"/>.
    /// </summary>
    public class SolutionVM : CodeObjectVM
    {
        #region /* STATICS */

        internal static void AddViewModelMapping()
        {
            CreateViewModel.Add(typeof(Solution),
                delegate(CodeObject codeObject, bool isDescription, Dictionary<CodeObject, CodeObjectVM> dictionary) { return new SolutionVM((Solution)codeObject, isDescription, dictionary); });
        }

        #endregion

        #region /* FIELDS */

        protected ChildListVM<ProjectVM> _projectVMs;
        protected ObservableCollectionMT<CodeAnnotation> _codeAnnotations;

        #endregion

        #region /* CONSTRUCTORS */

        /// <summary>
        /// Create a view model instance for the specified <see cref="CodeDOM.Solution"/>.
        /// </summary>
        public SolutionVM(Solution solution, bool isDescription, Dictionary<CodeObject, CodeObjectVM> dictionary)
            : base(solution, dictionary)
        {
            if (!isDescription)
            {
                _projectVMs = CreateListVM<Project, ProjectVM>(solution.Projects, dictionary);
                _codeAnnotations = ObservableCollectionMT<CodeAnnotation>.Create();
                solution.CodeAnnotations.CollectionChanged += SolutionCodeAnnotations_Changed;
            }
        }

        /// <summary>
        /// Create a view model instance for the specified <see cref="CodeDOM.Solution"/>.
        /// </summary>
        public SolutionVM(Solution solution, bool isDescription)
            : this(solution, isDescription, null)
        { }

        /// <summary>
        /// Create a view model instance for the specified <see cref="CodeDOM.Solution"/>.
        /// </summary>
        public SolutionVM(Solution solution)
            : this(solution, false, null)
        { }

        #endregion

        #region /* PROPERTIES */

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

        /// <summary>
        /// The child <see cref="ProjectVM"/>s.
        /// </summary>
        public ChildListVM<ProjectVM> ProjectVMs
        {
            get { return _projectVMs; }
        }

        /// <summary>
        /// All 'listed' annotations (<see cref="Message"/>s and special <see cref="Comment"/>s) for the entire <see cref="Solution"/>.
        /// </summary>
        public ObservableCollectionMT<CodeAnnotation> CodeAnnotations
        {
            get { return _codeAnnotations; }
        }

        #endregion

        #region /* METHODS */

        /// <summary>
        /// Handle any items added or removed from the wrapped <see cref="CodeDOM.Solution.CodeAnnotations"/> collection.
        /// </summary>
        protected void SolutionCodeAnnotations_Changed(object obj, NotifyCollectionChangedEventArgs args)
        {
            switch (args.Action)
            {
                case NotifyCollectionChangedAction.Add:
                    foreach (object item in args.NewItems)
                        _codeAnnotations.Add((CodeAnnotation)item);
                    break;
                case NotifyCollectionChangedAction.Remove:
                    foreach (object item in args.OldItems)
                        _codeAnnotations.Remove((CodeAnnotation)item);
                    break;
            }
        }

        /// <summary>
        /// Unload the <see cref="Solution"/> - unload all <see cref="Project"/>s, <see cref="FrameworkContext"/>s, the master <see cref="ApplicationContext"/>
        /// instance, clear all <see cref="CodeAnnotation"/>s, etc.
        /// </summary>
        public void Unload()
        {
            Solution.Unload();
            CodeRenderer.PurgeCachedData();
        }

        #endregion

        #region /* RENDERING */

        public override void RenderToolTip(CodeRenderer renderer, RenderFlags flags)
        {
            // Don't bother displaying the type - just the file name
            renderer.RenderText(Solution.FileName, NORMAL_BRUSH, TextStyle.Proportional, this);
            RenderMessagesInToolTip(renderer, flags);

            // Display configuration and platform
            string configuration = Solution.ActiveConfiguration;
            if (configuration != null)
            {
                string platform = Solution.ActivePlatform;
                if (platform != null)
                    configuration += " - " + platform;
                renderer.RenderNameValue("Configuration", configuration);
            }
        }

        #endregion
    }
}