DMDirc-Plugins/ui_swing/src/main/java/com/dmdirc/addons/ui_swing/injection/SwingModule.java

/*
 * Copyright (c) 2006-2017 DMDirc Developers
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
 * OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package com.dmdirc.addons.ui_swing.injection;

import com.dmdirc.ClientModule;
import com.dmdirc.addons.ui_swing.Apple;
import com.dmdirc.addons.ui_swing.MainFrame;
import com.dmdirc.addons.ui_swing.NoopClipboard;
import com.dmdirc.addons.ui_swing.QuitWorker;
import com.dmdirc.addons.ui_swing.SimpleActiveFrameManager;
import com.dmdirc.addons.ui_swing.SwingController;
import com.dmdirc.addons.ui_swing.SwingManager;
import com.dmdirc.addons.ui_swing.UIUtilities;
import com.dmdirc.addons.ui_swing.commands.ChannelSettings;
import com.dmdirc.addons.ui_swing.commands.Input;
import com.dmdirc.addons.ui_swing.commands.PopInCommand;
import com.dmdirc.addons.ui_swing.commands.PopOutCommand;
import com.dmdirc.addons.ui_swing.commands.ServerSettings;
import com.dmdirc.addons.ui_swing.components.IconManager;
import com.dmdirc.addons.ui_swing.components.addonpanel.PluginPanel;
import com.dmdirc.addons.ui_swing.components.addonpanel.ThemePanel;
import com.dmdirc.addons.ui_swing.components.statusbar.ErrorPanel;
import com.dmdirc.addons.ui_swing.components.statusbar.InviteLabel;
import com.dmdirc.addons.ui_swing.components.statusbar.MessageLabel;
import com.dmdirc.addons.ui_swing.components.statusbar.SwingStatusBar;
import com.dmdirc.addons.ui_swing.components.statusbar.UpdaterLabel;
import com.dmdirc.addons.ui_swing.dialogs.prefs.URLConfigPanel;
import com.dmdirc.addons.ui_swing.dialogs.prefs.UpdateConfigPanel;
import com.dmdirc.addons.ui_swing.events.SwingEventBus;
import com.dmdirc.addons.ui_swing.framemanager.FrameManager;
import com.dmdirc.addons.ui_swing.framemanager.FrameManagerProvider;
import com.dmdirc.addons.ui_swing.framemanager.tree.TreeFrameManagerProvider;
import com.dmdirc.addons.ui_swing.interfaces.ActiveFrameManager;
import com.dmdirc.config.GlobalConfig;
import com.dmdirc.config.UserConfig;
import com.dmdirc.config.prefs.PreferencesDialogModel;
import com.dmdirc.interfaces.ConnectionManager;
import com.dmdirc.events.eventbus.EventBus;
import com.dmdirc.interfaces.LifecycleController;
import com.dmdirc.interfaces.config.AggregateConfigProvider;
import com.dmdirc.interfaces.config.ConfigProvider;
import com.dmdirc.plugins.PluginDomain;
import com.dmdirc.plugins.PluginInfo;
import com.dmdirc.plugins.ServiceLocator;
import com.dmdirc.plugins.ServiceManager;
import com.dmdirc.ui.core.util.URLHandler;
import com.dmdirc.util.URLBuilder;
import dagger.Module;
import dagger.Provides;
import java.awt.Toolkit;
import java.awt.Window;
import java.awt.datatransfer.Clipboard;
import javax.inject.Provider;
import javax.inject.Singleton;

/**
 * Dagger module that provides Swing-specific dependencies.
 */
@Module(
        addsTo = ClientModule.class,
        includes = DialogModule.class,
        injects = {
            SwingManager.class,
            PopInCommand.class,
            PopOutCommand.class,
            Input.class,
            ServerSettings.class,
            ChannelSettings.class
        })
@SuppressWarnings("TypeMayBeWeakened")
public class SwingModule {

    private final SwingController controller;
    private final PluginInfo pluginInfo;
    private final String domain;

    public SwingModule(final SwingController controller, final PluginInfo pluginInfo,
            final String domain) {
        this.controller = controller;
        this.pluginInfo = pluginInfo;
        this.domain = domain;
    }

    @Provides
    @PluginDomain(SwingController.class)
    public String getSettingsDomain() {
        return domain;
    }

    @Provides
    public SwingController getController() {
        return controller;
    }

    @Provides
    @Singleton
    public Clipboard getClipboard() {
        if (Toolkit.getDefaultToolkit().getSystemClipboard() == null) {
            return new NoopClipboard();
        } else {
            return Toolkit.getDefaultToolkit().getSystemClipboard();
        }
    }

    @Provides
    @Singleton
    public MainFrame getMainFrame(
            final Apple apple,
            final LifecycleController lifecycleController,
            @GlobalConfig final AggregateConfigProvider globalConfig,
            final Provider<QuitWorker> quitWorker,
            final URLBuilder urlBuilder,
            final Provider<FrameManager> frameManagerProvider,
            final EventBus eventBus,
            final SwingEventBus swingEventBus) {
        return UIUtilities.invokeAndWait(() -> new MainFrame(
                apple,
                lifecycleController,
                globalConfig,
                quitWorker,
                new IconManager(globalConfig, urlBuilder),
                frameManagerProvider,
                eventBus,
                swingEventBus));
    }

    @Provides
    @Singleton
    @MainWindow
    public Window getMainWindow(final MainFrame mainFrame) {
        return mainFrame;
    }

    @Provides
    @Singleton
    public ActiveFrameManager getActiveFrameManager(final SimpleActiveFrameManager frameManager,
            final SwingEventBus eventBus) {
        eventBus.subscribe(frameManager);
        return frameManager;
    }

    @Provides
    @Singleton
    public SwingStatusBar getSwingStatusBar(
            final InviteLabel inviteLabel,
            final ErrorPanel errorLabel,
            final UpdaterLabel updaterLabel,
            final MessageLabel messageLabel,
            final EventBus eventBus) {
        final SwingStatusBar sb = UIUtilities.invokeAndWait(
                () -> new SwingStatusBar(inviteLabel, updaterLabel, errorLabel, messageLabel));
        eventBus.subscribe(messageLabel);
        eventBus.subscribe(sb);
        return sb;
    }

    @Provides
    @Singleton
    public URLHandler getURLHandler(
            final EventBus eventBus,
            @GlobalConfig final AggregateConfigProvider globalConfig,
            final ConnectionManager connectionManager) {
        return new URLHandler(eventBus, globalConfig, connectionManager);
    }

    @Provides
    public PreferencesDialogModel getPrefsDialogModel(
            final PluginPanel pluginPanel,
            final ThemePanel themePanel,
            final UpdateConfigPanel updatePanel,
            final URLConfigPanel urlPanel,
            @GlobalConfig final AggregateConfigProvider configManager,
            @UserConfig final ConfigProvider identity,
            final ServiceManager serviceManager,
            final EventBus eventBus) {
        return new PreferencesDialogModel(pluginPanel, themePanel, updatePanel, urlPanel,
                configManager, identity, serviceManager, eventBus);
    }

    @Provides
    public FrameManager getFrameManager(
            @GlobalConfig final AggregateConfigProvider globalConfig,
            final TreeFrameManagerProvider fallbackProvider,
            final ServiceLocator locator) {
        final String manager = globalConfig.getOption("ui", "framemanager");

        FrameManagerProvider provider = locator.getService(FrameManagerProvider.class, manager);
        if (provider == null) {
            // Couldn't find the user's selected provider - let's just use the fallback.
            provider = fallbackProvider;
        }

        return provider.getFrameManager();
    }

    @Provides
    @PluginDomain(SwingController.class)
    public PluginInfo getPluginInfo() {
        return pluginInfo;
    }

}