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 terminalHasFocus() const;
  60     bool hasProgramRunning() const;
  61     QString runningProgramName() const;
  62
  63 public slots:
  64     void terminalExited();
  65     void dockVisibilityChanged();
  66
  67 signals:
  68     void hideTerminalPanel();
  69
  70     /**
  71      * Is emitted if the an URL change is requested.
  72      */
  73     void changeUrl(const QUrl& url);
  74
  75 protected:
  76     bool urlChanged() override;
  77
  78     void showEvent(QShowEvent* event) override;
  79
  80 private slots:
  81     void slotMostLocalUrlResult(KJob* job);
  82     void slotKonsolePartCurrentDirectoryChanged(const QString& dir);
  83
  84 private:
  85     enum class HistoryPolicy {
  86         AddToHistory,
  87         SkipHistory
  88     };
  89
  90     void changeDir(const QUrl& url);
  91     void sendCdToTerminal(const QString& path, HistoryPolicy addToHistory = HistoryPolicy::AddToHistory);
  92
  93 private:
  94     bool m_clearTerminal;
  95     KIO::StatJob* m_mostLocalUrlJob;
  96
  97     QVBoxLayout* m_layout;
  98     TerminalInterface* m_terminal;
  99     QWidget* m_terminalWidget;
 100     KMessageWidget* m_konsolePartMissingMessage;
 101     KParts::ReadOnlyPart* m_konsolePart;
 102     QString m_konsolePartCurrentDirectory;
 103     QQueue<QString> m_sendCdToTerminalHistory;
 104 };
 105
 106 #endif // TERMINALPANEL_H