// Copyright (C) Stichting Deltares 2021. All rights reserved.
//
// This file is part of Riskeer.
//
// Riskeer is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser 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;
using System.Collections.Generic;
using System.Linq;
using Core.Common.Controls.TreeView;
using Core.Common.Gui.Helpers;

namespace Core.Common.Gui.Plugin
{
    /// <summary>
    /// Template class for a plug-in definitions.
    /// </summary>
    public abstract class PluginBase : IDisposable
    {
        private IInquiryHelper inquiryHelper;

        /// <summary>
        /// Gets or sets the gui.
        /// </summary>
        public virtual IGui Gui { get; set; }

        /// <summary>
        /// Activates the plug-in.
        /// </summary>
        public virtual void Activate() {}

        /// <summary>
        /// Deactivates the plug-in.
        /// </summary>
        public virtual void Deactivate() {}

        /// <summary>
        /// Returns all <see cref="ImportInfo"/> instances provided by this plug-in.
        /// </summary>
        public virtual IEnumerable<ImportInfo> GetImportInfos()
        {
            yield break;
        }

        /// <summary>
        /// Returns all <see cref="UpdateInfo"/> instances provided by this plug-in.
        /// </summary>
        public virtual IEnumerable<UpdateInfo> GetUpdateInfos()
        {
            yield break;
        }

        /// <summary>
        /// Returns all <see cref="ExportInfo"/> instances provided by this plug-in.
        /// </summary>
        public virtual IEnumerable<ExportInfo> GetExportInfos()
        {
            yield break;
        }

        /// <summary>
        /// Returns all <see cref="PropertyInfo"/> instances by of this plug-in.
        /// </summary>
        public virtual IEnumerable<PropertyInfo> GetPropertyInfos()
        {
            return Enumerable.Empty<PropertyInfo>();
        }

        /// <summary>
        /// Returns all <see cref="ViewInfo"/> instances provided by this plug-in.
        /// </summary>
        public virtual IEnumerable<ViewInfo> GetViewInfos()
        {
            yield break;
        }

        /// <summary>
        /// Returns all <see cref="TreeNodeInfo"/> instances provided by this plug-in.
        /// </summary>
        public virtual IEnumerable<TreeNodeInfo> GetTreeNodeInfos()
        {
            yield break;
        }

        /// <summary>
        /// Gets the child data instances that have <see cref="ViewInfo"/> definitions of
        /// some parent data object.
        /// </summary>
        /// <param name="viewData">The parent data object.</param>
        /// <returns>Sequence of child data.</returns>
        public virtual IEnumerable<object> GetChildDataWithViewDefinitions(object viewData)
        {
            yield break;
        }

        public void Dispose()
        {
            Dispose(true);
            GC.SuppressFinalize(this);
        }

        protected virtual void Dispose(bool disposing)
        {
            if (disposing)
            {
                Gui = null;
            }
        }

        /// <summary>
        /// Returns the <see cref="IInquiryHelper"/>.
        /// </summary>
        /// <returns>The <see cref="IInquiryHelper"/>.</returns>
        /// <exception cref="InvalidOperationException">Thrown when <see cref="Gui"/>
        /// is <c>null</c>.</exception>
        protected IInquiryHelper GetInquiryHelper()
        {
            if (Gui == null)
            {
                throw new InvalidOperationException("Gui cannot be null");
            }

            return inquiryHelper ?? (inquiryHelper = new DialogBasedInquiryHelper(Gui.MainWindow));
        }
    }
}