//-----------------------------------------------------------------------
// <copyright file="ILogging.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 SharedObjects
{
    using System.IO;
    using global::SharedObjects.Api;
    using global::SharedObjects.CAN.Objects;

    /// <summary>
    /// Various methods for event logging.
    /// In no way the best logging, and with hindsight
    /// Log4Net should have been selected.
    /// </summary>
    public interface ILogging
    {
        /// <summary>
        /// Append a text with log level LOG_INFO.
        /// Notice: The caller must supply line breaks.
        /// </summary>
        /// <param name="txt">Text to append.</param>
        void appendText(string txt);

        /// <summary>
        /// Append a text with log level LOG_INFO.
        /// Notice: The caller must supply line breaks.
        /// </summary>
        /// <param name="txt">Text to append.</param>
        void appendTextLn(string txt);

        /// <summary>
        /// Append a text with log level LOG_INFO.
        /// Notice: The caller must supply line breaks.
        /// </summary>
        void appendTextLn();

        /// <summary>
        /// Append a text with the given log level.
        /// Notice: The caller must supply line breaks.
        /// </summary>
        /// <param name="txt">Text to append.</param>
        /// <param name="logLevel">Logging level.</param>
        /// <returns>'true' if execution can continue.</returns>
        bool appendText(string txt, int logLevel);

        /// <summary>
        /// Display contents of a message to/from the PassThru interface.
        /// </summary>
        /// <param name="prefix">Prefix to use when displaying message, useful to distinguish between sent and received messages.</param>
        /// <param name="msg">Message to display.</param>
        void dispMsg(string prefix, IPassThruMsg msg);

        /// <summary>
        /// Display contents of a message to/from the PassThru interface.
        /// </summary>
        /// <param name="prefix">Prefix to use when displaying message, useful to distinguish between sent and received messages.</param>
        /// <param name="msg">Message to display.</param>
        /// <param name="addressStr">Message address.</param>
        /// <param name="data">Message data.</param>
        void dispMsg(string prefix, IPassThruMsg msg, string addressStr, string data);

        /// <summary>
        /// Test the result code for error and log.
        /// </summary>
        /// <param name="passThruDevice">Involved device.</param>
        /// <param name="res">Result code to test.</param>
        /// <returns>'true' if execution can continue.</returns>
        bool errTestDevice(IPassThruDevice passThruDevice, PassThruConstants.resultCode res);

        /// <summary>
        /// Test the result code for error and log.
        /// </summary>
        /// <param name="passThruConnection">Related connection.</param>
        /// <param name="res">Result code to test.</param>
        /// <returns>'true' if execution can continue.</returns>
        bool errTestConnection(IPassThruConnection passThruConnection, PassThruConstants.resultCode res);

        /// <summary>
        /// Test the result code for error and log.
        /// </summary>
        /// <param name="passThruDevice">Involved device.</param>
        /// <param name="res">Result code to test</param>
        /// <param name="errtext">Related error message (out data)</param>
        /// <returns>'true' if execution can continue.</returns>
        bool errTestDevice(IPassThruDevice passThruDevice, PassThruConstants.resultCode res, out string errtext);

        /// <summary>
        /// Test the result code for error and log.
        /// </summary>
        /// <param name="passThruConnection">Related connection.</param>
        /// <param name="res">Result code to test</param>
        /// <param name="errtext">Related error message (out data)</param>
        /// <returns>'true' if execution can continue.</returns>
        bool errTestConnection(IPassThruConnection passThruConnection, PassThruConstants.resultCode res, out string errtext);

        /// <summary>
        /// Get the writer for the data log (CSV format) file.
        /// </summary>
        /// <returns>TextWriter instance</returns>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate", Justification = "Suitable in this case.")]
        TextWriter getValueDataLogWriter();

        /// <summary>
        /// Get the writer for the CAN data (ASC format) log.
        /// </summary>
        /// <returns>TextWriter instance</returns>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate", Justification = "Suitable in this case.")]
        TextWriter getCanDataLogWriter();

        /// <summary>
        /// Add one row to the traffic table.
        /// </summary>
        /// <param name="direction">Traffic direction and layer level.</param>
        /// <param name="address">Address field.</param>
        /// <param name="mode">Mode field.</param>
        /// <param name="pid">PID field.</param>
        /// <param name="length">Payload length.</param>
        /// <param name="rspStr">Payload data.</param>
        void addRow(rowMode direction, uint address, byte mode, uint pid, uint length, string rspStr);

        /// <summary>
        /// Add raw log data to binary log file.
        /// </summary>
        /// <param name="rawLogObject">Binary object to write to file.</param>
        void addRawData(RawLogObject rawLogObject);
    }

    /// <summary>
    /// Log row modes.
    /// </summary>
    public enum rowMode
    {
        /// <summary>
        /// Log raw in data.
        /// </summary>
        transport_in,

        /// <summary>
        /// Log raw out data.
        /// </summary>
        transport_out,

        /// <summary>
        /// Log Session layer in data.
        /// </summary>
        session_in,

        /// <summary>
        /// Log Session layer out data.
        /// </summary>
        session_out,

        /// <summary>
        /// Log formatted in data.
        /// </summary>
        presentation_in,

        /// <summary>
        /// Log formatted out data.
        /// </summary>
        presentation_out,

        /// <summary>
        /// Data discarded - no response sent.
        /// </summary>
        data_discard,
    }

    /// <summary>
    /// Log levels.
    /// </summary>
    public static class LogLevel
    {
        /// <summary>
        /// Error message.
        /// </summary>
        public const int LOG_ERROR = 5;

        /// <summary>
        /// Warning message.
        /// </summary>
        public const int LOG_WARN = 4;

        /// <summary>
        /// Information message.
        /// </summary>
        public const int LOG_INFO = 3;

        /// <summary>
        /// Debug message.
        /// </summary>
        public const int LOG_DEBUG = 2;

        /// <summary>
        /// Trace message.
        /// </summary>
        public const int LOG_TRACE = 1;
    }
}