TerminalCharacterDecoder.h

Go to the documentation of this file.

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

    Copyright 2006-2008 by Robert Knight <robertknight@gmail.com>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU Lesser 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 Lesser 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 TERMINAL_CHARACTER_DECODER_H
#define TERMINAL_CHARACTER_DECODER_H

// Qt
#include <QtCore/QList>

// Konsole
#include "Character.h"
#include "konsole_export.h"

class QTextStream;

namespace Konsole
{
class KONSOLEPRIVATE_EXPORT TerminalCharacterDecoder
{
public:
    virtual ~TerminalCharacterDecoder() {}

    virtual void begin(QTextStream* output) = 0;
    virtual void end() = 0;

    virtual void decodeLine(const Character* const characters,
                            int count,
                            LineProperty properties) = 0;
};

class KONSOLEPRIVATE_EXPORT PlainTextDecoder : public TerminalCharacterDecoder
{
public:
    PlainTextDecoder();

    void setTrailingWhitespace(bool enable);
    bool trailingWhitespace() const;
    QList<int> linePositions() const;
    void setRecordLinePositions(bool record);

    virtual void begin(QTextStream* output);
    virtual void end();

    virtual void decodeLine(const Character* const characters,
                            int count,
                            LineProperty properties);

private:
    QTextStream* _output;
    bool _includeTrailingWhitespace;

    bool _recordLinePositions;
    QList<int> _linePositions;
};

class KONSOLEPRIVATE_EXPORT HTMLDecoder : public TerminalCharacterDecoder
{
public:
    HTMLDecoder();

    void setColorTable(const ColorEntry* table);

    virtual void decodeLine(const Character* const characters,
                            int count,
                            LineProperty properties);

    virtual void begin(QTextStream* output);
    virtual void end();

private:
    void openSpan(QString& text , const QString& style);
    void closeSpan(QString& text);

    QTextStream* _output;
    const ColorEntry* _colorTable;
    bool _innerSpanOpen;
    quint8 _lastRendition;
    CharacterColor _lastForeColor;
    CharacterColor _lastBackColor;
};
}

#endif