qt-creator/src/libs/utils/ssh/sshpseudoterminal.h

/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** No Commercial Usage
**
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**************************************************************************/
#ifndef SSHPSEUDOTERMINAL_H
#define SSHPSEUDOTERMINAL_H

#include <utils/utils_global.h>

#include <QtCore/QByteArray>
#include <QtCore/QHash>

namespace Utils {

class QTCREATOR_UTILS_EXPORT SshPseudoTerminal
{
  public:
    SshPseudoTerminal(const QByteArray &termType = "vt100", int rowCount = 24,
             int columnCount = 80)
        : termType(termType), rowCount(rowCount), columnCount(columnCount) {}

    QByteArray termType;
    int rowCount;
    int columnCount;

    enum Mode {
        VINTR = 1,      // Interrupt character.
        VQUIT = 2,      // The quit character (sends SIGQUIT signal on POSIX systems).
        VERASE = 3,     // Erase the character to left of the cursor.
        VKILL = 4,      // Kill the current input line.
        VEOF = 5,       // End-of-file character (sends EOF from the terminal).
        VEOL = 6,       // End-of-line character in addition to carriage return and/or linefeed.
        VEOL2 = 7,      // Additional end-of-line character.
        VSTART = 8,     // Continues paused output (normally control-Q).
        VSTOP = 9,      // Pauses output (normally control-S).
        VSUSP = 10,     // Suspends the current program.
        VDSUSP = 11,    // Another suspend character.
        VREPRINT = 12,  // Reprints the current input line.
        VWERASE = 13,   // Erases a word left of cursor.
        VLNEXT = 14,    // Enter the next character typed literally, even if it is a special character.
        VFLUSH = 15,    // Character to flush output.
        VSWTCH = 16,    // Switch to a different shell layer.
        VSTATUS = 17,   // Prints system status line (load, command, pid, etc).
        VDISCARD = 18,  // Toggles the flushing of terminal output.

        IGNPAR = 30,    // The ignore parity flag.  The parameter SHOULD be 0 if this flag is FALSE, and 1 if it is TRUE.
        PARMRK = 31,    // Mark parity and framing errors.
        INPCK = 32,     // Enable checking of parity errors.
        ISTRIP = 33,    // Strip 8th bit off characters.
        INLCR = 34,     // Map NL into CR on input.
        IGNCR = 35,     // Ignore CR on input.
        ICRNL = 36,     // Map CR to NL on input.
        IUCLC = 37,     // Translate uppercase characters to lowercase.
        IXON = 38,      // Enable output flow control.
        IXANY = 39,     // Any char will restart after stop.
        IXOFF = 40,     // Enable input flow control.
        IMAXBEL = 41,   // Ring bell on input queue full.
        ISIG = 50,      // Enable signals INTR, QUIT, [D]SUSP.
        ICANON = 51,    // Canonicalize input lines.
        XCASE = 52,     // Enable input and output of uppercase characters by preceding their lowercase equivalents with "\".
        ECHO = 53,      // Enable echoing.
        ECHOE = 54,     // Visually erase chars.
        ECHOK = 55,     // Kill character discards current line.
        ECHONL = 56,    // Echo NL even if ECHO is off.
        NOFLSH = 57,    // Don't flush after interrupt.
        TOSTOP = 58,    // Stop background jobs from output.
        IEXTEN = 59,    // Enable extensions.
        ECHOCTL = 60,   // Echo control characters as ^(Char).
        ECHOKE = 61,    // Visual erase for line kill.
        PENDIN = 62,    // Retype pending input.
        OPOST = 70,     // Enable output processing.
        OLCUC = 71,     // Convert lowercase to uppercase.
        ONLCR = 72,     // Map NL to CR-NL.
        OCRNL = 73,     // Translate carriage return to newline (output).
        ONOCR = 74,     // Translate newline to carriage return-newline (output).
        ONLRET = 75,    // Newline performs a carriage return (output).
        CS7 = 90,       // 7 bit mode.
        CS8 = 91,       // 8 bit mode.
        PARENB = 92,    // Parity enable.
        PARODD = 93,    // Odd parity, else even.

        TTY_OP_ISPEED = 128,  // Specifies the input baud rate in bits per second.
        TTY_OP_OSPEED = 129   // Specifies the output baud rate in bits per second.
    };

    typedef QHash<Mode, quint32> ModeMap;
    ModeMap modes;
};

} // namespace Utils

#endif // SSHPSEUDOTERMINAL_H