PluginMain.cs

using System;
using System.IO;
using System.Windows.Forms;
using System.ComponentModel;
using PluginCore.Localization;
using PluginCore.Utilities;
using PluginCore.Managers;
using PluginCore;
using System.Drawing;
using System.Runtime.InteropServices;
using EditorMiniMap.Helpers;
using System.Linq;
using ScintillaNet;

namespace EditorMiniMap
{
    public class PluginMain : IPlugin
    {
        private const int API_KEY = 1;
        private const String NAME = "EditorMiniMap";
        private const String GUID = "1F4B503B-E512-4a2d-B80D-15C87DD6D5FA";
        private const String HELP = "www.flashdevelop.org/community/viewtopic.php?f=4&t=9397";
        private const String DESCRIPTION = "Adds a minimap to code documents.";
        private const String AUTHOR = "Joey Robichaud";

        private String _settingsFilename = "";
        private Settings _settings = null;
        private ToolStripMenuItem _toggleMenuItem = null;

        #region Required Properties

        /// <summary>
        /// Api level of the plugin
        /// </summary>
        public Int32 Api
        {
            get { return API_KEY; }
        }

        /// <summary>
        /// Name of the plugin
        /// </summary> 
        public String Name
        {
            get { return NAME; }
        }

        /// <summary>
        /// GUID of the plugin
        /// </summary>
        public String Guid
        {
            get { return GUID; }
        }

        /// <summary>
        /// Author of the plugin
        /// </summary> 
        public String Author
        {
            get { return AUTHOR; }
        }

        /// <summary>
        /// Description of the plugin
        /// </summary> 
        public String Description
        {
            get { return DESCRIPTION; }
        }

        /// <summary>
        /// Web address for help
        /// </summary>
        public String Help
        {
            get { return HELP; }
        }

        /// <summary>
        /// Object that contains the settings
        /// </summary>
        [Browsable(false)]
        public Object Settings
        {
            get { return this._settings; }
        }

        #endregion

        #region Required Methods

        /// <summary>
        /// Initializes the plugin
        /// </summary>
        public void Initialize()
        {
            this.InitBasics();
            this.LoadSettings();
            this.CreateMenuItems();
            this.AddEventHandlers();
        }

        /// <summary>
        /// Disposes the plugin
        /// </summary>
        public void Dispose()
        {
            this.SaveSettings();
        }

        /// <summary>
        /// Handles the incoming events
        /// </summary>
        public void HandleEvent(Object sender, NotifyEvent e, HandlingPriority prority)
        {
            if (e.Type == EventType.FileOpen)
            {
                TryAddMiniMapPanels(PluginBase.MainForm.CurrentDocument);
            }
            else if (e.Type == EventType.FileSwitch)
            {
                // Scintilla control Visible property does not seem to respect getting set when
                // the control is not visible. So when switching to a new document, we have to
                // refresh the settings.
                RefreshMiniMapPanels(PluginBase.MainForm.CurrentDocument);
            }
        }

        #endregion

        #region Plugin Methods

        private void TryAddMiniMapPanels(ITabbedDocument document)
        {
            if (document == null)
                return;

            TryAddMiniMapPanel(document, document.SplitSci1);
            TryAddMiniMapPanel(document, document.SplitSci2);
        }

        private MiniMapPanel TryAddMiniMapPanel(ITabbedDocument document, ScintillaControl sci)
        {
            if (document == null || sci == null)
                return null;

            MiniMapPanel miniMapPanel = TryGetMiniMapPanel(document, sci);
            if (miniMapPanel != null)
                return null;

            var panel = new MiniMapPanel(document, sci, _settings);

            var splitter = document.Controls.OfType<SplitContainer>().FirstOrDefault();
            if (splitter == null)
                return null;

            if (document.SplitSci1 == sci)
                splitter.Panel1.Controls.Add(panel);
            else if (document.SplitSci2 == sci)
                splitter.Panel2.Controls.Add(panel);

            return panel;
        }

        private void RefreshMiniMapPanels(ITabbedDocument document)
        {
            RefreshMiniMapPanel(document, document.SplitSci1);
            RefreshMiniMapPanel(document, document.SplitSci2);
        }

        private void RefreshMiniMapPanel(ITabbedDocument document, ScintillaControl sci)
        {
            var miniMapPanel = TryGetMiniMapPanel(document, sci)
                            ?? TryAddMiniMapPanel(document, sci);

            if (miniMapPanel != null)
                miniMapPanel.RefreshSettings();
        }

        private MiniMapPanel TryGetMiniMapPanel(ITabbedDocument document, ScintillaControl sci)
        {
            if (document == null || sci == null)
                return null;

            var splitter = document.Controls.OfType<SplitContainer>().FirstOrDefault();
            if (splitter == null)
                return null;

            if (document.SplitSci1 == sci)
                return splitter.Panel1.Controls.OfType<MiniMapPanel>().FirstOrDefault();
            else if (document.SplitSci2 == sci)
                return splitter.Panel2.Controls.OfType<MiniMapPanel>().FirstOrDefault();

            return null;
        }

        private void ToggleMiniMap(object sender, EventArgs e)
        {
            _settings.IsVisible = !_settings.IsVisible;
        }

        void settingObject_OnSettingsChanged()
        {
            if (_settings.IsVisible != _toggleMenuItem.Checked)
                _toggleMenuItem.Checked = _settings.IsVisible;
        }

        #endregion

        #region Custom Methods

        /// <summary>
        /// Initializes important variables
        /// </summary>
        public void InitBasics()
        {
            String dataPath = Path.Combine(PluginCore.Helpers.PathHelper.DataDir, NAME);
            if (!Directory.Exists(dataPath)) Directory.CreateDirectory(dataPath);
            _settingsFilename = Path.Combine(dataPath, "Settings.fdb");
        }

        /// <summary>
        /// Adds the required event handlers
        /// </summary>
        public void AddEventHandlers()
        {
            // Set events you want to listen (combine as flags)
            EventManager.AddEventHandler(this, EventType.FileOpen | EventType.FileSwitch);
            _settings.OnSettingsChanged += new SettingsChangesEvent(settingObject_OnSettingsChanged);
        }

        /// <summary>
        /// Adds shortcuts for manipulating the mini map
        /// </summary>
        public void CreateMenuItems()
        {
            ToolStripMenuItem menu = (ToolStripMenuItem)PluginBase.MainForm.FindMenuItem("ViewMenu");

            _toggleMenuItem = new ToolStripMenuItem(ResourceHelper.GetString("EditorMiniMap.Label.ToggleMiniMap"), ResourceHelper.GetImage("MiniMap"), new EventHandler(ToggleMiniMap));
            _toggleMenuItem.Checked = _settings.IsVisible;
            PluginBase.MainForm.RegisterShortcutItem("EditorMiniMap.ShowMiniMap", _toggleMenuItem);

            int index = menu.DropDownItems.IndexOfKey("FullScreen") + 1;
            index = index > -1 ? index : 0;

            if (!(menu.DropDownItems[index] is ToolStripSeparator))
                menu.DropDownItems.Insert(index, new ToolStripSeparator());

            menu.DropDownItems.Insert(index + 1, _toggleMenuItem);
        }

        /// <summary>
        /// Loads the plugin settings
        /// </summary>
        public void LoadSettings()
        {
            _settings = new Settings();
            if (!File.Exists(_settingsFilename)) this.SaveSettings();
            else
            {
                Object obj = ObjectSerializer.Deserialize(_settingsFilename, _settings);
                _settings = (Settings)obj;
                _settings.MaxLineLimit = _settings.MaxLineLimit;
            }
        }

        /// <summary>
        /// Saves the plugin settings
        /// </summary>
        public void SaveSettings()
        {
            ObjectSerializer.Serialize(_settingsFilename, _settings);
        }

		#endregion
	}
}