// Copyright (c) 2007 Omer Rauchwerger (a.k.a rauchy) (omer@rauchy.net)
// All rights reserved.
//
// This file is part of Regionerate.
// 
// This program is free software; you can redistribute it and/or modify it 
// under the terms of the GNU General Public License as published by 
// the Free Software Foundation; either version 3 of the License, 
// or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Xml;

namespace Rauchy.Regionerate.ServiceLayer.Components.Projects
{
    /// <summary>
    /// Provides access to the names of the compiled files in a Visual Studio project file.
    /// </summary>
    public abstract class Project : IEnumerable<Document>
    {
        #region Fields (2) 

        private readonly string _name;
        private readonly XmlDocument _projectFile;

        #endregion Fields 

        #region Constructors (1) 

        /// <summary>
        /// Initializes a new instance of the <see cref="Project"/> class.
        /// </summary>
        /// <param name="path">The path.</param>
        protected Project( string path )
        {
            _name = Path.GetFileName( path );
            _projectFile = new XmlDocument();
            ProjectFile.Load( path );
        }

        #endregion Constructors 

        #region Properties (2) 

        /// <summary>
        /// Gets the name of this <see cref="Project"/>.
        /// </summary>
        public string Name
        {
            get
            {
                return _name;
            }
        }

        protected XmlDocument ProjectFile
        {
            get
            {
                return _projectFile;
            }
        }

        #endregion Properties 

        #region Methods (2) 

        // Public Methods (1) 

        ///<summary>
        ///Returns an enumerator that iterates through the collection.
        ///</summary>
        ///
        ///<returns>
        ///A <see cref="T:System.Collections.Generic.IEnumerator`1"></see> that can be used to iterate through the collection.
        ///</returns>
        ///<filterpriority>1</filterpriority>
        public abstract IEnumerator<Document> GetEnumerator();

        // Private Methods (1) 

        /// <summary>
        /// Returns an enumerator that iterates through a collection.
        /// </summary>
        /// <returns>
        /// An <see cref="T:System.Collections.IEnumerator"></see> object that can be used to iterate through the collection.
        /// </returns>
        IEnumerator IEnumerable.GetEnumerator()
        {
            return GetEnumerator();
        }

        #endregion Methods 
    }
}