File indexing completed on 2024-05-05 05:51:22

 /* This file is part of the KDE project
  *
  *  SPDX-FileCopyrightText: 2019 Dominik Haumann <dhaumann@kde.org>
  *
  *  SPDX-License-Identifier: LGPL-2.0-or-later
  */
 #pragma once
 
 #include <KTextEditor/Plugin>
 #include <QList>
 
 #include <KSharedConfig>
 
 namespace KTextEditor
 {
 class View;
 }
 
 class KateExternalToolsMenuAction;
 class KateExternalToolsPluginView;
 class KateExternalToolsCommand;
 class KateExternalTool;
 class KateToolRunner;
 
 class KateExternalToolsPlugin : public KTextEditor::Plugin
 {
     Q_OBJECT
 
 public:
     explicit KateExternalToolsPlugin(QObject *parent = nullptr, const QVariantList & = QVariantList());
     ~KateExternalToolsPlugin() override;
 
     /**
      * Returns the global config object for the plugin (on Linux
      * this is ~/.config/kateexternaltoolspluginrc).
      */
     KSharedConfigPtr config()
     {
         return m_config;
     }
 
     /**
      * Reimplemented to return the number of config pages, in this case 1.
      */
     int configPages() const override;
 
     /**
      * Reimplemented to return the KateExternalToolConfigWidget for number==0.
      */
     KTextEditor::ConfigPage *configPage(int number = 0, QWidget *parent = nullptr) override;
 
     /**
      * Reimplemented to instantiate a PluginView for each MainWindow.
      */
     QObject *createView(KTextEditor::MainWindow *mainWindow) override;
 
     /**
      * Deletes all tools.
      */
     void clearTools();
 
     /**
      * Reloads the external tools configuration from disk.
      */
     void reload();
 
     /**
      * Returns a list of KTextEDitor::Command strings. This is needed by
      * the KateExternalToolsCommand constructor to pass the list of commands to
      * the KTextEditor::Editor.
      */
     QStringList commands() const;
 
     /**
      * Returns the KateExternalTool for a specific command line command 'cmd.
      */
     const KateExternalTool *toolForCommand(const QString &cmd) const;
 
     /**
      * Returns a list of all existing external tools.
      */
     const QList<KateExternalTool *> &tools() const;
 
     /**
      * Returns the list of external tools that are shipped by default with
      * the external tools plugin.
      */
     QList<KateExternalTool> defaultTools() const;
 
     /**
      * Executes the tool based on the view as current document.
      */
     void runTool(const KateExternalTool &tool, KTextEditor::View *view, bool executingSaveTrigger = false);
 
     /**
      * Executes the tool based on the view as current document.
      * same as @ref runTool but waits for the tool to finish before returning
      */
     void blockingRunTool(const KateExternalTool &tool, KTextEditor::View *view, bool executingSaveTrigger = false);
 
 Q_SIGNALS:
     /**
      * This signal is emitted whenever the external tools change.
      * This is typically the case when external tools were modified,
      * added, or removed via the config page.
      */
     void externalToolsChanged();
 
 public:
     /**
      * Called by the KateExternalToolsPluginView to register itself.
      */
     void registerPluginView(KateExternalToolsPluginView *view);
 
     /**
      * Called by the KateExternalToolsPluginView to unregister itself.
      */
     void unregisterPluginView(KateExternalToolsPluginView *view);
 
     /**
      * Returns the KateExternalToolsPluginView for the given mainWindow.
      */
     KateExternalToolsPluginView *viewForMainWindow(KTextEditor::MainWindow *mainWindow) const;
 
     void addNewTool(KateExternalTool *tool);
 
     /**
      * Removes the tools in @p toRemove, this includes removing the relevant
      * config file from disk.
      */
     void removeTools(const std::vector<KateExternalTool *> &toRemove);
 
     /**
      * Saves @p tool config. If @p oldName is not empty, then the tool's name
      * was changed, and after saving the config (to a new file based on the
      * new name), the old config file is removed.
      */
     static void save(KateExternalTool *tool, const QString &oldName);
 
 private:
     void migrateConfig();
     KateToolRunner *runnerForTool(const KateExternalTool &tool, KTextEditor::View *view, bool executingSaveTrigger);
 
     KSharedConfigPtr m_config;
     QList<KateExternalTool> m_defaultTools;
     QList<KateExternalToolsPluginView *> m_views;
     QList<KateExternalTool *> m_tools;
     QStringList m_commands;
     KateExternalToolsCommand *m_command = nullptr;
 
 private Q_SLOTS:
     /**
      * Called whenever an external tool is done.
      */
     void handleToolFinished(KateToolRunner *runner, int exitCode, bool crashed);
 };
 
 // kate: space-indent on; indent-width 4; replace-tabs on;