src/panels/terminal/terminalpanel.h

   1 /***************************************************************************
   2  *   Copyright (C) 2007-2010 by Peter Penz <peter.penz19@gmail.com>        *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  18  ***************************************************************************/
  19
  20 #ifndef TERMINALPANEL_H
  21 #define TERMINALPANEL_H
  22
  23 #include "panels/panel.h"
  24
  25 #include <QQueue>
  26
  27 class TerminalInterface;
  28 class KMessageWidget;
  29 class QVBoxLayout;
  30 class QWidget;
  31
  32 namespace KIO {
  33     class StatJob;
  34 }
  35
  36 namespace KParts {
  37     class ReadOnlyPart;
  38 }
  39 class KJob;
  40 /**
  41  * @brief Shows the terminal which is synchronized with the URL of the
  42  *        active view.
  43  */
  44 class TerminalPanel : public Panel
  45 {
  46     Q_OBJECT
  47
  48 public:
  49     explicit TerminalPanel(QWidget* parent = nullptr);
  50     ~TerminalPanel() override;
  51
  52     /**
  53      * @brief This function is used to set the terminal panels's cwd to
  54      *        home when an unmounting request is received.
  55      */
  56     void goHome();
  57     QString currentWorkingDirectory();
  58     bool isHiddenInVisibleWindow() const;
  59     bool hasProgramRunning() const;
  60     QString runningProgramName() const;
  61
  62 public slots:
  63     void terminalExited();
  64     void dockVisibilityChanged();
  65
  66 signals:
  67     void hideTerminalPanel();
  68
  69     /**
  70      * Is emitted if the an URL change is requested.
  71      */
  72     void changeUrl(const QUrl& url);
  73
  74 protected:
  75     bool urlChanged() override;
  76
  77     void showEvent(QShowEvent* event) override;
  78
  79 private slots:
  80     void slotMostLocalUrlResult(KJob* job);
  81     void slotKonsolePartCurrentDirectoryChanged(const QString& dir);
  82
  83 private:
  84     enum class HistoryPolicy {
  85         AddToHistory,
  86         SkipHistory
  87     };
  88
  89     void changeDir(const QUrl& url);
  90     void sendCdToTerminal(const QString& path, HistoryPolicy addToHistory = HistoryPolicy::AddToHistory);
  91
  92 private:
  93     bool m_clearTerminal;
  94     KIO::StatJob* m_mostLocalUrlJob;
  95
  96     QVBoxLayout* m_layout;
  97     TerminalInterface* m_terminal;
  98     QWidget* m_terminalWidget;
  99     KMessageWidget* m_konsolePartMissingMessage;
 100     KParts::ReadOnlyPart* m_konsolePart;
 101     QString m_konsolePartCurrentDirectory;
 102     QQueue<QString> m_sendCdToTerminalHistory;
 103 };
 104
 105 #endif // TERMINALPANEL_H