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 QVBoxLayout;
  29 class QWidget;
  30
  31 namespace KIO {
  32     class StatJob;
  33 }
  34
  35 namespace KParts {
  36     class ReadOnlyPart;
  37 }
  38 class KJob;
  39 /**
  40  * @brief Shows the terminal which is synchronized with the URL of the
  41  *        active view.
  42  */
  43 class TerminalPanel : public Panel
  44 {
  45     Q_OBJECT
  46
  47 public:
  48     explicit TerminalPanel(QWidget* parent = nullptr);
  49     ~TerminalPanel() override;
  50
  51     /**
  52      * @brief This function is used to set the terminal panels's cwd to
  53      *        home when an unmounting request is received.
  54      */
  55     void goHome();
  56     QString currentWorkingDirectory();
  57     bool isHiddenInVisibleWindow();
  58
  59 public slots:
  60     void terminalExited();
  61     void dockVisibilityChanged();
  62
  63 signals:
  64     void hideTerminalPanel();
  65
  66     /**
  67      * Is emitted if the an URL change is requested.
  68      */
  69     void changeUrl(const QUrl& url);
  70
  71 protected:
  72     bool urlChanged() override;
  73
  74     void showEvent(QShowEvent* event) override;
  75
  76 private slots:
  77     void slotMostLocalUrlResult(KJob* job);
  78     void slotKonsolePartCurrentDirectoryChanged(const QString& dir);
  79
  80 private:
  81     enum class HistoryPolicy {
  82         AddToHistory,
  83         SkipHistory
  84     };
  85
  86     void changeDir(const QUrl& url);
  87     void sendCdToTerminal(const QString& path, HistoryPolicy addToHistory = HistoryPolicy::AddToHistory);
  88
  89 private:
  90     bool m_clearTerminal;
  91     KIO::StatJob* m_mostLocalUrlJob;
  92
  93     QVBoxLayout* m_layout;
  94     TerminalInterface* m_terminal;
  95     QWidget* m_terminalWidget;
  96     KParts::ReadOnlyPart* m_konsolePart;
  97     QString m_konsolePartCurrentDirectory;
  98     QQueue<QString> m_sendCdToTerminalHistory;
  99 };
 100
 101 #endif // TERMINALPANEL_H