cool-retro-term/yat/backend/screen.h

/**************************************************************************************************
* Copyright (c) 2012 Jørgen Lind
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
* associated documentation files (the "Software"), to deal in the Software without restriction,
* including without limitation the rights to use, copy, modify, merge, publish, distribute,
* sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or
* substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
* NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT
* OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
***************************************************************************************************/

#ifndef TERMINALSCREEN_H
#define TERMINALSCREEN_H

#include <QObject>

#include "text.h"
#include "color_palette.h"
#include "parser.h"
#include "yat_pty.h"
#include "update_action.h"
#include "screen_data.h"

#include <QtCore/QPoint>
#include <QtCore/QSize>
#include <QtCore/QStack>
#include <QtCore/QElapsedTimer>

class Line;
class QQuickItem;
class QQmlEngine;
class QQmlComponent;

class Screen : public QObject
{
    Q_OBJECT

    Q_PROPERTY(int height READ height WRITE setHeight)
    Q_PROPERTY(int width READ width WRITE setWidth)
    Q_PROPERTY(QString title READ title WRITE setTitle NOTIFY screenTitleChanged)
    Q_PROPERTY(bool cursorVisible READ cursorVisible NOTIFY cursorVisibleChanged)
    Q_PROPERTY(bool cursorBlinking READ cursorBlinking NOTIFY cursorBlinkingChanged)
    Q_PROPERTY(bool selectionEnabled READ selectionEnabled NOTIFY selectionEnabledChanged)
    Q_PROPERTY(QPointF selectionAreaStart READ selectionAreaStart WRITE setSelectionAreaStart NOTIFY selectionAreaStartChanged)
    Q_PROPERTY(QPointF selectionAreaEnd READ selectionAreaEnd WRITE setSelectionAreaEnd NOTIFY selectionAreaEndChanged)

public:
    enum InsertMode {
        Insert,
        Replace
    };

    explicit Screen(QObject *parent = 0);
    ~Screen();

    void setHeight(int height);
    int height() const;
    void setWidth(int width);
    int width() const;

    void saveScreenData();
    void restoreScreenData();

    void setInsertMode(InsertMode mode);

    void setTextStyle(TextStyle::Style style, bool add = true);
    void resetStyle();
    TextStyle currentTextStyle() const;
    TextStyle defaultTextStyle() const;

    Q_INVOKABLE QColor screenBackground();
    QColor defaultForgroundColor() const;
    QColor defaultBackgroundColor() const;

    void setTextStyleColor(ushort color);
    const ColorPalette *colorPalette() const;

    QPoint cursorPosition() const;

    void moveCursorHome();
    void moveCursorTop();
    void moveCursorUp(int n_positions = 1);
    void moveCursorDown();
    void moveCursorLeft();
    void moveCursorRight(int n_positions);
    void moveCursor(int x, int y);
    void moveCursorToLine(int line);
    void moveCursorToCharacter(int character);

    void deleteCharacters(int characters);

    void setCursorVisible(bool visible);
    bool cursorVisible();
    void setCursorBlinking(bool blinking);
    bool cursorBlinking();
    void saveCursor();
    void restoreCursor();

    void replaceAtCursor(const QString &text);

    void insertEmptyCharsAtCursor(int len);

    void backspace();

    void eraseLine();
    void eraseFromCursorPositionToEndOfLine();
    void eraseFromCursorPosition(int n_chars);
    void eraseFromCurrentLineToEndOfScreen();
    void eraseFromCurrentLineToBeginningOfScreen();
    void eraseToCursorPosition();
    void eraseScreen();

    void lineFeed();
    void reverseLineFeed();
    void insertLines(int count);
    void deleteLines(int count);

    void setScrollArea(int from, int to);

    QPointF selectionAreaStart() const;
    void setSelectionAreaStart(const QPointF &start);
    QPointF selectionAreaEnd() const;
    void setSelectionAreaEnd(const QPointF &end);

    bool selectionEnabled() const;
    Q_INVOKABLE void setSelectionEnabled(bool enabled);

    Q_INVOKABLE void sendSelectionToClipboard() const;
    Q_INVOKABLE void sendSelectionToSelection() const;
    Q_INVOKABLE void pasteFromSelection();
    Q_INVOKABLE void pasteFromClipboard();

    Q_INVOKABLE void doubleClicked(const QPointF &clicked);

    void setTitle(const QString &title);
    QString title() const;

    void scheduleFlash();

    Q_INVOKABLE Line *at(int i) const;

    Q_INVOKABLE void printScreen() const;

    void dispatchChanges();

    void sendPrimaryDA();
    void sendSecondaryDA();

    void setCharacterMap(const QString &string);
    QString characterMap() const;
    void setApplicationCursorKeysMode(bool enable);
    bool applicationCursorKeyMode() const;

    Q_INVOKABLE void sendKey(const QString &text, Qt::Key key, Qt::KeyboardModifiers modifiers);

    YatPty *pty();

    //For tests
    Line *line_at_cursor() const;
public slots:
    void readData(const QByteArray &data);

signals:
    void moveLines(int from_line, int to_line, int count);

    void reset();

    void flash();

    void dispatchLineChanges();
    void dispatchTextSegmentChanges();

    void selectionAreaStartChanged();
    void selectionAreaEndChanged();
    void selectionEnabledChanged();

    void screenTitleChanged();

    void cursorPositionChanged(int x, int y);
    void cursorVisibleChanged();
    void cursorBlinkingChanged();

    void lineCreated(Line *line);
protected:
    void timerEvent(QTimerEvent *);

private:
    void moveLine(qint16 from, qint16 to);
    void scheduleMoveSignal(qint16 from, qint16 to);

    ScreenData *current_screen_data() const { return m_screen_stack[m_screen_stack.size()-1]; }
    QPoint &current_cursor_pos() { return m_cursor_stack[m_cursor_stack.size()-1]; }
    int current_cursor_x() const { return m_cursor_stack.at(m_cursor_stack.size()-1).x(); }
    int current_cursor_y() const { return m_cursor_stack.at(m_cursor_stack.size()-1).y(); }

    void setSelectionValidity();

    ColorPalette m_palette;
    YatPty m_pty;
    Parser m_parser;
    QElapsedTimer m_time_since_parsed;

    int m_timer_event_id;

    QVector<ScreenData *> m_screen_stack;
    QVector<QPoint> m_cursor_stack;

    bool m_cursor_visible;
    bool m_cursor_visible_changed;
    bool m_cursor_blinking;
    bool m_cursor_blinking_changed;

    TextStyle m_current_text_style;
    QString m_title;

    InsertMode m_insert_mode;

    bool m_selection_valid;
    bool m_selection_moved;
    QPointF m_selection_start;
    QPointF m_selection_end;

    QString m_character_map;

    QList<UpdateAction> m_update_actions;
    bool m_flash;
    bool m_cursor_changed;
    bool m_reset;
    bool m_application_cursor_key_mode;

    friend class ScreenData;
};

#endif // TERMINALSCREEN_H