//-----------------------------------------------------------------------
// <copyright file="XmlParserHelper.cs" company="bedug.com">
//     Copyright © 2012 Nils Hammar. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------
/*
 * Software to access vehicle information via the OBD-II connector.
 * 
 * Copyright © 2012 Nils Hammar
 * 
 * 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/>.
 * 
 * Alternative licensing is possible, see the licensing document.
 * 
 * The above text may not be removed or modified.
 */

namespace DataSource.FileAccess
{
    using System.Xml;
    using System.Xml.Serialization;
    using global::SharedObjects;

    /// <summary>
    /// Helper class for common XML functions.
    /// </summary>
    public class XmlParserHelper
    {
        /// <summary>
        /// Gets Logging interface.
        /// </summary>
        protected ILogging iLogging { get; private set; }

        /// <summary>
        /// Gets data file directory.
        /// </summary>
        protected string dataFileDir { get; private set; }

        /// <summary>
        /// Initializes a new instance of the <see cref="XmlParserHelper" /> class.
        /// </summary>
        /// <param name="iLogging">Logging interface.</param>
        /// <param name="dataFileDir">Data file directory path.</param>
        protected XmlParserHelper(ILogging iLogging, string dataFileDir)
        {
            this.iLogging = iLogging;
            this.dataFileDir = dataFileDir;
        }

        /// <summary>
        /// When an unknown XML node was encountered.
        /// </summary>
        /// <param name="sender">Sending object</param>
        /// <param name="e">Event data</param>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1062:Validate arguments of public methods", MessageId = "1", Justification = "Shall never be 'null'.")]
        protected void xms_UnknownNode(object sender, XmlNodeEventArgs e)
        {
            this.iLogging.appendText("Unknown Node:" + e.Name + "\t" + e.Text + "\r\n");
        }

        /// <summary>
        /// When an unknown XML attribute was encountered.
        /// </summary>
        /// <param name="sender">Sending object</param>
        /// <param name="e">Event data</param>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1062:Validate arguments of public methods", MessageId = "1", Justification = "Shall never be 'null'.")]
        protected void xms_UnknownAttribute(object sender, XmlAttributeEventArgs e)
        {
            System.Xml.XmlAttribute attr = e.Attr;
            this.iLogging.appendText("Unknown Attribute:" + attr.Name + "\t" + attr.Value + "\r\n");
        }

        /// <summary>
        /// When an unknown XML element was encountered.
        /// </summary>
        /// <param name="sender">Sending object</param>
        /// <param name="e">Event data</param>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1062:Validate arguments of public methods", MessageId = "1", Justification = "Shall never be 'null'.")]
        protected void xms_UnknownElement(object sender, XmlElementEventArgs e)
        {
            XmlElement el = e.Element;
            this.iLogging.appendText("Unknown Element:" + el.Name + "\t" + el.InnerText + "\r\n");
        }

        /// <summary>
        /// When an unreferenced object was encountered.
        /// </summary>
        /// <param name="sender">Sending object</param>
        /// <param name="e">Event data</param>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1062:Validate arguments of public methods", MessageId = "1", Justification = "Shall never be 'null'.")]
        protected void xms_UnreferencedObject(object sender, UnreferencedObjectEventArgs e)
        {
            this.iLogging.appendText("Unreferenced object:" + e.UnreferencedId + "\r\n");
        }
    }
}