//-----------------------------------------------------------------------
// <copyright file="PassThruDevice.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 DeviceApi.J2534
{
    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Text;
    using System.Windows.Forms;
    using global::DeviceApi.Serial;
    using global::SharedObjects;
    using global::SharedObjects.Api;
    using global::SharedObjects.Misc;

    /// <summary>
    /// Handle one J2534 device.
    /// It is possible to handle more than one device if needed.
    /// </summary>
    public class PassThruDevice : IPassThruDevice
    {
        /// <summary>
        /// List of supported interfaces by this application.
        /// <para>
        /// Notice: Last interface is the simulator interface useful for testing
        /// and replay of raw logs.
        /// </para>
        /// </summary>
        private static IList<IPassThru> interfaceList = new List<IPassThru>()
        {
            new SerialAtAgvPassThru(),
            new SerialAtElmPassThru(),
#if SIMPLE_SERIAL
            new SimpleSerialPassThru(),
#endif
        };

        /* Instance specific. */

        /// <summary>
        /// Current Device ID.
        /// </summary>
        private int DeviceIDInt = -1;

        /// <summary>
        /// Gets current Device ID.
        /// </summary>
        public int DeviceID
        {
            get { return this.DeviceIDInt; }
        }

        /// <summary>
        /// Gets Current interface implementation used.
        /// </summary>
        public IPassThru passThruInterface { get; private set; }

        /// <summary>
        /// Gets Last known error encountered.
        /// </summary>
        public string lastError { get; private set; }

        /// <summary>
        /// Logging interface.
        /// </summary>
        private ILogging iLogging;

        /// <summary>
        /// Initializes a new instance of the <see cref="PassThruDevice" /> class.
        /// </summary>
        /// <param name="iLogging">Logging interface.</param>
        /// <param name="passThruInterface">The interface implementation to use for the device.</param>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1062:Validate arguments of public methods", MessageId = "1", Justification = "Reviewed")]
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1062:Validate arguments of public methods", MessageId = "0", Justification = "Reviewed")]
        public PassThruDevice(ILogging iLogging, IPassThru passThruInterface)
        {
            this.iLogging = iLogging;
            this.DeviceIDInt = -1;
            this.passThruInterface = passThruInterface;

            try
            {
                if (probeDevice(passThruInterface) != 0)
                {
                    MessageBox.Show(
                        "No device found.",
                        "Warning",
                        MessageBoxButtons.OK,
                        MessageBoxIcon.Exclamation);
                }
            }
            catch (BadImageFormatException ex)
            {
                iLogging.appendText("Incompatible Driver for: " + passThruInterface.name + "\r\n" + ex.Message + "\r\n", LogLevel.LOG_WARN);
            }
            catch (DllNotFoundException ex)
            {
                iLogging.appendText("No Driver installed for: " + passThruInterface.name + "\r\n" + ex.Message + "\r\n", LogLevel.LOG_WARN);
            }
            catch (Exception e)
            {
                MessageBox.Show(
                    "No driver found.\r\n\r\n" + e.Message,
                    "Error",
                    MessageBoxButtons.OK,
                    MessageBoxIcon.Stop);
            }
        }

        /// <summary>
        /// Add static interfaces.
        /// </summary>
        public static void addStaticInterfaces()
        {
            /*
            interfaceList.Insert(0, new DicePassThru());
            interfaceList.Insert(0, new UwaPassThru());
            interfaceList.Insert(0, new TactrixPassThru());
             */
        }

        /// <summary>
        /// Add interface.
        /// </summary>
        /// <param name="iPassThru">Interface to add.</param>
        public static void addDynamicInterface(IPassThru iPassThru)
        {
            interfaceList.Insert(0, iPassThru);
        }

        /// <summary>
        /// Close the device.
        /// </summary>
        public static void close()
        {
        }

        /// <summary>
        /// Get supported interfaces where a device is connected.
        /// </summary>
        /// <param name="iLogging">Logging instance.</param>
        /// <returns>Array of possible interfaces.</returns>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1062:Validate arguments of public methods", MessageId = "0", Justification = "Intentional since iLogging shall never be 'null'.")]
        public static IPassThru[] getInterfaces(ILogging iLogging)
        {
            List<IPassThru> l1 = new List<IPassThru>();

            foreach (IPassThru interfaceItem in interfaceList)
            {
                try
                {
                    if (probeDevice(interfaceItem) == 0)
                    {
                        l1.Add(interfaceItem);
                        iLogging.appendText("Found Device: " + interfaceItem.name + "\r\n", LogLevel.LOG_INFO);
                    }
                    else
                    {
                        iLogging.appendText("Found Driver but no Device: " + interfaceItem.name + "\r\n", LogLevel.LOG_WARN);
                    }
                }
                catch (BadImageFormatException ex)
                {
                    iLogging.appendText("Incompatible Driver for: " + interfaceItem.name + "\r\n" + ex.Message + "\r\n", LogLevel.LOG_WARN);
                }
                catch (DllNotFoundException ex)
                {
                    iLogging.appendText("No Driver installed for: " + interfaceItem.name + "\r\n" + ex.Message + "\r\n", LogLevel.LOG_WARN);
                }
            }

            return l1.ToArray<IPassThru>();
        }

        /// <summary>
        /// Gets the name of the interface.
        /// </summary>
        public string name
        {
            get
            {
                return this.passThruInterface.name;
            }
        }

        /// <summary>
        /// Check if the interface is declared to have a disconnect bug.
        /// </summary>
        /// <returns>'true' if a known disconnect bug exists.</returns>
        public bool disconnectBug()
        {
            return this.passThruInterface.disconnectBug();
        }

        /// <summary>
        /// Execute PassThruOpen on the device.
        /// </summary>
        /// <returns>Result status, 0=success.</returns>
        public unsafe PassThruConstants.resultCode Gl_PassThruOpen()
        {
            PassThruConstants.resultCode ret = 0;
            fixed (int* pDeviceID = &this.DeviceIDInt)
            {
                ret = this.passThruInterface.PassThruOpen(null, pDeviceID);
                if (ret != PassThruConstants.resultCode.ERR_SUCCESS)
                {
                    this.lastError = this.Gl_PassThruGetLastError();
                }
                else
                {
                    this.lastError = PassThruConstants.SUCCESS;
                }
            }

            return ret;
        }

        /// <summary>
        /// Close the device.
        /// </summary>
        /// <returns>Result status, 0=success.</returns>
        public PassThruConstants.resultCode Gl_PassThruClose()
        {
            PassThruConstants.resultCode ret = this.passThruInterface.PassThruClose(this.DeviceID);

            if (ret != PassThruConstants.resultCode.ERR_SUCCESS)
            {
                this.lastError = this.Gl_PassThruGetLastError();
            }
            else
            {
                this.lastError = PassThruConstants.SUCCESS;
            }

            return ret;
        }

        /// <summary>
        /// Set programming voltage on the interface.
        /// </summary>
        /// <param name="Pin">Pin to configure.</param>
        /// <param name="Voltage">Voltage to set.</param>
        /// <returns>Result status, 0=success.</returns>
        public PassThruConstants.resultCode Gl_PassThruSetProgrammingVoltage(int Pin, int Voltage)
        {
            PassThruConstants.resultCode ret = this.passThruInterface.PassThruSetProgrammingVoltage(this.DeviceID, Pin, Voltage);
            if (ret != PassThruConstants.resultCode.ERR_SUCCESS)
            {
                this.lastError = this.Gl_PassThruGetLastError();
            }
            else
            {
                this.lastError = PassThruConstants.SUCCESS;
            }

            return ret;
        }

        /// <summary>
        /// Read version of API.
        /// </summary>
        /// <param name="ApiVersion">API Version (out value)</param>
        /// <param name="DllVersion">DLL Version (out value)</param>
        /// <param name="FirmwareVersion">Firmware Version (out value)</param>
        /// <returns>Result status, 0=success.</returns>
        public unsafe PassThruConstants.resultCode Gl_PassThruReadVersion(out string ApiVersion, out string DllVersion, out string FirmwareVersion)
        {
            PassThruConstants.resultCode stat = 0;
            string xApiVersion = "                                                                                  ";
            string xDllVersion = "                                                                                  ";
            string xFirmwareVersion = "                                                                                  ";
            byte[] aApiVersion = Encoding.UTF8.GetBytes(xApiVersion);
            byte[] aDllVersion = Encoding.UTF8.GetBytes(xDllVersion);
            byte[] aFirmwareVersion = Encoding.UTF8.GetBytes(xFirmwareVersion);
            fixed (byte* pApiVersion = aApiVersion, pDllVersion = aDllVersion, pFirmwareVersion = aFirmwareVersion)
            {
                stat = this.passThruInterface.PassThruReadVersion(this.DeviceID, pFirmwareVersion, pDllVersion, pApiVersion);
                if (stat != PassThruConstants.resultCode.ERR_SUCCESS)
                {
                    this.lastError = this.Gl_PassThruGetLastError();
                }
                else
                {
                    this.lastError = PassThruConstants.SUCCESS;
                }

                ApiVersion = Encoding.UTF8.GetString(Encoding.Convert(Encoding.GetEncoding("iso-8859-1"), Encoding.UTF8, aApiVersion), 0, Utils.strlen(aApiVersion));
                DllVersion = Encoding.UTF8.GetString(Encoding.Convert(Encoding.GetEncoding("iso-8859-1"), Encoding.UTF8, aDllVersion), 0, Utils.strlen(aDllVersion));
                FirmwareVersion = Encoding.UTF8.GetString(Encoding.Convert(Encoding.GetEncoding("iso-8859-1"), Encoding.UTF8, aFirmwareVersion), 0, Utils.strlen(aFirmwareVersion));
            }

            return stat;
        }

        /// <summary>
        /// Establish a connection on the device.
        /// </summary>
        /// <param name="ProtocolID">Protocol to use.</param>
        /// <param name="Flags">Connection flags.</param>
        /// <param name="Baudrate">Baudrate to connect with.</param>
        /// <param name="channelID">Channel ID assigned (out value)</param>
        /// <returns>Result status, 0=success.</returns>
        public unsafe PassThruConstants.resultCode Gl_PassThruConnect(int ProtocolID, uint Flags, uint Baudrate, out int channelID)
        {
            PassThruConstants.resultCode ret = 0;

            this.iLogging.appendText("PassThruConnect(" + this.DeviceID + ", " + ProtocolID + ", " + Flags + ", " + Baudrate + ", int *channelId)\r\n");

            fixed (int* pChannelID = &channelID)
            {
                ret = this.passThruInterface.PassThruConnect(this.DeviceID, ProtocolID, Flags, Baudrate, pChannelID);
            }

            this.iLogging.appendText("ret=" + ret + ",  channel=" + channelID + "\r\n");

            return ret;
        }

        /// <summary>
        /// Probe an interface for a device.
        /// </summary>
        /// <param name="passThruInterface">Interface to probe.</param>
        /// <returns>Result code, 0=success.</returns>
        private static unsafe PassThruConstants.resultCode probeDevice(IPassThru passThruInterface)
        {
            PassThruConstants.resultCode ret = 0;
            int DeviceID = -1;
            int* pDeviceID = &DeviceID;

            ret = passThruInterface.PassThruOpen(null, pDeviceID);
            passThruInterface.PassThruClose(DeviceID);

            return ret;
        }

        /// <summary>
        /// Get the last error from the interface.
        /// </summary>
        /// <returns>Result status, 0=success.</returns>
        private unsafe string Gl_PassThruGetLastError()
        {
            sbyte[] ca = new sbyte[512];
            string str = string.Empty;
            fixed (sbyte* p = ca)
            {
                *p = (sbyte)0;
                PassThruConstants.resultCode res = 0;
                if ((res = this.passThruInterface.PassThruGetLastError(p)) != 0)
                {
                    str = " * PassThruGetLastError() FAILED with error '" + res + "'! * ";
                }
                else
                {
                    str = new string(p);
                }
            }

            return str;
        }
    }
}