Pty.h

Go to the documentation of this file.

/*
    This file is part of Konsole, KDE's terminal emulator.

    Copyright 2007-2008 by Robert Knight <robertknight@gmail.com>
    Copyright 1997,1998 by Lars Doelle <lars.doelle@on-line.de>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301  USA.
*/

#ifndef PTY_H
#define PTY_H

// Qt
#include <QtCore/QSize>

// KDE
#include <KPtyProcess>

// Konsole
#include "konsole_export.h"

class QStringList;

namespace Konsole
{
class KONSOLEPRIVATE_EXPORT Pty: public KPtyProcess
{
    Q_OBJECT

public:
    explicit Pty(QObject* parent = 0);

    explicit Pty(int ptyMasterFd, QObject* parent = 0);

    ~Pty();

    int start(const QString& program,
              const QStringList& arguments,
              const QStringList& environment
             );

    void setWriteable(bool writeable);

    void setFlowControlEnabled(bool on);

    bool flowControlEnabled() const;

    void setWindowSize(int columns, int lines);

    QSize windowSize() const;

    void setEraseChar(char eraseChar);

    char eraseChar() const;

    void setInitialWorkingDirectory(const QString& dir);

    int foregroundProcessGroup() const;

    void closePty();

public slots:
    void setUtf8Mode(bool on);

    void sendData(const char* buffer, int length);

signals:
    void receivedData(const char* buffer, int length);

protected:
    void setupChildProcess();

private slots:
    // called when data is received from the terminal process
    void dataReceived();

private:
    void init();

    // takes a list of key=value pairs and adds them
    // to the environment for the process
    void addEnvironmentVariables(const QStringList& environment);

    int  _windowColumns;
    int  _windowLines;
    char _eraseChar;
    bool _xonXoff;
    bool _utf8;
};
}

#endif // PTY_H