Solution.cs

Go to the documentation of this file.

#region License

// Copyright (c) 2014 Silicon Studio Corp. (http://siliconstudio.co.jp)
// This file is distributed under MIT License. See LICENSE.md for details.
//
// SLNTools
// Copyright (c) 2009 
// by Christian Warren
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated 
// documentation files (the "Software"), to deal in the Software without restriction, including without limitation 
// the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and 
// to permit persons to whom the Software is furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all copies or substantial portions
// of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
// TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF 
// CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
// DEALINGS IN THE SOFTWARE.

#endregion

using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.Linq;

namespace SiliconStudio.Core.VisualStudio
{
    /// <summary>
    /// A VisualStudio solution.
    /// </summary>
    [DebuggerDisplay("Projects = [{Projects.Count}]")]
    public class Solution
    {
        private readonly SectionCollection globalSections;
        private readonly List<string> headers;
        private readonly ProjectCollection projects;

        /// <summary>
        /// Initializes a new instance of the <see cref="Solution"/> class.
        /// </summary>
        public Solution()
        {
            FullPath = null;
            headers = new List<string>();
            projects = new ProjectCollection(this);
            globalSections = new SectionCollection();
            Properties = new PropertyItemCollection();
        }

        private Solution(Solution original)
            : this(original.FullPath, original.Headers, original.Projects, original.GlobalSections, original.Properties)
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="Solution" /> class.
        /// </summary>
        /// <param name="fullpath">The fullpath.</param>
        /// <param name="headers">The headers.</param>
        /// <param name="projects">The projects.</param>
        /// <param name="globalSections">The global sections.</param>
        /// <param name="properties">The properties.</param>
        public Solution(string fullpath, IEnumerable<string> headers, IEnumerable<Project> projects, IEnumerable<Section> globalSections, IEnumerable<PropertyItem> properties)
        {
            FullPath = fullpath;
            this.headers = new List<string>(headers);
            this.projects = new ProjectCollection(this, projects);
            this.globalSections = new SectionCollection(globalSections);
            this.Properties = new PropertyItemCollection(properties);
        }

        /// <summary>
        /// Gets or sets the full path.
        /// </summary>
        /// <value>The full path.</value>
        public string FullPath { get; set; }

        /// <summary>
        /// Gets all projects that are not folders.
        /// </summary>
        /// <value>The children.</value>
        public IEnumerable<Project> Children
        {
            get
            {
                return projects.Where(project => project.ParentProject == null);
            }
        }

        /// <summary>
        /// Gets the global sections.
        /// </summary>
        /// <value>The global sections.</value>
        public SectionCollection GlobalSections
        {
            get
            {
                return globalSections;
            }
        }

        /// <summary>
        /// Gets the headers.
        /// </summary>
        /// <value>The headers.</value>
        public List<string> Headers
        {
            get
            {
                return headers;
            }
        }

        /// <summary>
        /// Gets all projects.
        /// </summary>
        /// <value>The projects.</value>
        public ProjectCollection Projects
        {
            get
            {
                return projects;
            }
        }

        /// <summary>
        /// Gets the properties.
        /// </summary>
        /// <value>The properties.</value>
        public PropertyItemCollection Properties { get; private set; }

        /// <summary>
        /// Clones this instance.
        /// </summary>
        /// <returns>Solution.</returns>
        public Solution Clone()
        {
            return new Solution(this);
        }

        /// <summary>
        /// Saves this instance to the <see cref="FullPath"/> path.
        /// </summary>
        public void Save()
        {
            SaveAs(FullPath);
        }

        /// <summary>
        /// Saves this instance to the specified path.
        /// </summary>
        /// <param name="solutionPath">The solution path.</param>
        public void SaveAs(string solutionPath)
        {
            using (var writer = new SolutionWriter(solutionPath))
            {
                writer.WriteSolutionFile(this);
            }
        }

        /// <summary>
        /// Loads the solution from the specified file.
        /// </summary>
        /// <param name="solutionFullPath">The solution full path.</param>
        /// <returns>Solution.</returns>
        public static Solution FromFile(string solutionFullPath)
        {
            using (var reader = new SolutionReader(solutionFullPath))
            {
                var solution = reader.ReadSolutionFile();
                solution.FullPath = solutionFullPath;
                return solution;
            }
        }

        /// <summary>
        /// Loads the solution from the specified stream.
        /// </summary>
        /// <param name="solutionFullPath">The solution full path.</param>
        /// <param name="stream">The stream.</param>
        /// <returns>Solution.</returns>
        public static Solution FromStream(string solutionFullPath, Stream stream)
        {
            using (var reader = new SolutionReader(stream))
            {
                var solution = reader.ReadSolutionFile();
                solution.FullPath = solutionFullPath;
                return solution;
            }
        }
    }
}