// Copyright (C) Stichting Deltares 2020. All rights reserved.
//
// This file is part of the Dam Engine.
//
// The Dam Engine is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero 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 Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//
// All names, logos, and references to "Deltares" are registered trademarks of
// Stichting Deltares and remain full property of Stichting Deltares at all times.
// All rights reserved.

using System.Runtime.InteropServices;

namespace Deltares.LayerOnSlopeTool.StiFileCreator

{
    /// <summary>
    /// Structure for dll information
    /// </summary>
    [StructLayout(LayoutKind.Sequential, Pack = 1)]
    public struct DllVersionInfoStructure
    {
        /// <summary>
        /// Size of the structure, in bytes
        /// </summary>
        public uint CbSize;

        /// <summary>
        /// Major version of the DLL
        /// </summary>
        public uint DwMajorVersion;

        /// <summary>
        /// Minor version of the DLL
        /// </summary>
        public uint DwMinorVersion;

        /// <summary>
        /// Release number of the DLL
        /// </summary>
        public uint DwReleaseNumber;

        /// <summary>
        /// Build number of the DLL 
        /// </summary>
        public uint DwBuildNumber;

        /// <summary>
        /// Identifies the platform for which the DLL was built
        /// </summary>
        public uint DwPlatformID;
    }

    /// <summary>
    /// The standard DLL interface for DGS.
    /// </summary>
    public class DgsStandardDllInterface
    {
        /// <summary>
        /// No Licence error
        /// </summary>
        public const int DllUErrorNoLicense = 1;

        /// <summary>
        /// User has aborted error
        /// </summary>
        public const int DllErrorUserAborted = 2;

        /// <summary>
        /// Non compliant xml error
        /// </summary>
        public const int DllErrorNonCompliantXml = 3;

        /// <summary>
        /// Invalid input data error
        /// </summary>
        public const int DllErrorInvalidInputData = 4;

        /// <summary>
        /// Handled fatal error
        /// </summary>
        public const int DllErrorHandledFatal = 5;

        /// <summary>
        /// Unhandled fatal error
        /// </summary>
        public const int DllErrorUnhandledFatal = 6;

        /// <summary>
        /// Invalid handle for dll error
        /// </summary>
        public const int DllErrorInvalidHandle = 7;

        /// <summary>
        /// Output buffer too small error
        /// </summary>
        public const int DllErrorOutputBufferTooSmall = 8;

        /// <summary>
        ///     Error constants
        /// </summary>
        public static int DllErrorNone = 0;

        /// <summary>
        /// Used to hold the last error encountered
        /// </summary>
        public static int DllErrorLastErrorCode = 0;

        /// <summary>
        ///     Example! (remove this wrapper if not needed)
        /// </summary>
        /// <returns></returns>
        public string GetDllVersion()
        {
            return "To be implemented";
        }

        /// <summary>
        /// List of errormessages 
        /// </summary>
        /// <returns></returns>
        public string ErrorMessage()
        {
            return "To be implemented";
        }
    }
}