Emulation.h

Go to the documentation of this file.

/*
    This file is part of Konsole, an X terminal.

    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 EMULATION_H
#define EMULATION_H

// Qt
#include <QtCore/QSize>
#include <QtCore/QTextCodec>
#include <QtCore/QTimer>

// Konsole
#include "konsole_export.h"

class QKeyEvent;

namespace Konsole
{
class KeyboardTranslator;
class HistoryType;
class Screen;
class ScreenWindow;
class TerminalCharacterDecoder;

enum {
    NOTIFYNORMAL = 0,
    NOTIFYBELL = 1,
    NOTIFYACTIVITY = 2,

    // unused here?
    NOTIFYSILENCE = 3
};

class KONSOLEPRIVATE_EXPORT Emulation : public QObject
{
    Q_OBJECT

public:
    Emulation();
    ~Emulation();

    ScreenWindow* createWindow();

    QSize imageSize() const;

    int lineCount() const;

    void setHistory(const HistoryType&);
    const HistoryType& history() const;
    void clearHistory();

    virtual void writeToStream(TerminalCharacterDecoder* decoder, int startLine, int endLine);

    const QTextCodec* codec() const {
        return _codec;
    }
    void setCodec(const QTextCodec*);

    bool utf8() const {
        Q_ASSERT(_codec);
        return _codec->mibEnum() == 106;
    }


    virtual char eraseChar() const;

    void setKeyBindings(const QString& name);
    QString keyBindings() const;

    virtual void clearEntireScreen() = 0;

    virtual void reset() = 0;

    bool programUsesMouse() const;

public slots:

    virtual void setImageSize(int lines, int columns);

    virtual void sendText(const QString& text) = 0;

    virtual void sendKeyEvent(QKeyEvent*);

    virtual void sendMouseEvent(int buttons, int column, int line, int eventType);

    virtual void sendString(const char* string, int length = -1) = 0;

    void receiveData(const char* buffer, int len);

signals:

    void sendData(const char* data, int len);

    void useUtf8Request(bool);

    void stateSet(int state);

    void zmodemDetected();


    void changeTabTextColorRequest(int color);

    void programUsesMouseChanged(bool usesMouse);

    void outputChanged();

    void titleChanged(int title, const QString& newTitle);

    void imageSizeChanged(int lineCount , int columnCount);

    void imageSizeInitialized();

    void imageResizeRequest(const QSize& sizz);

    void profileChangeCommandReceived(const QString& text);

    void flowControlKeyPressed(bool suspendKeyPressed);

    void primaryScreenInUse(bool use);

    void selectionChanged(const QString& text);

protected:
    virtual void setMode(int mode) = 0;
    virtual void resetMode(int mode) = 0;

    virtual void receiveChar(int ch);

    void setScreen(int index);

    enum EmulationCodec {
        LocaleCodec = 0,
        Utf8Codec   = 1
    };

    void setCodec(EmulationCodec codec);

    QList<ScreenWindow*> _windows;

    Screen* _currentScreen;  // pointer to the screen which is currently active,
    // this is one of the elements in the screen[] array

    Screen* _screen[2];      // 0 = primary screen ( used by most programs, including the shell
    //                      scrollbars are enabled in this mode )
    // 1 = alternate      ( used by vi , emacs etc.
    //                      scrollbars are not enabled in this mode )


    //decodes an incoming C-style character stream into a unicode QString using
    //the current text codec.  (this allows for rendering of non-ASCII characters in text files etc.)
    const QTextCodec* _codec;
    QTextDecoder* _decoder;
    const KeyboardTranslator* _keyTranslator; // the keyboard layout

protected slots:
    void bufferedUpdate();

    // used to emit the primaryScreenInUse(bool) signal
    void checkScreenInUse();

    // used to emit the selectionChanged(QString) signal
    void checkSelectedText();

private slots:
    // triggered by timer, causes the emulation to send an updated screen image to each
    // view
    void showBulk();

    void usesMouseChanged(bool usesMouse);

private:
    bool _usesMouse;
    QTimer _bulkTimer1;
    QTimer _bulkTimer2;
    bool _imageSizeInitialized;
};
}

#endif // ifndef EMULATION_H