/*
Copyright (C) 2010 Srivats P.

This file is part of "Ostinato"

This 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 3 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, see <http://www.gnu.org/licenses/>
*/

#ifndef _TEXT_PROTOCOL_H
#define _TEXT_PROTOCOL_H

#include "abstractprotocol.h"
#include "textproto.pb.h"

/* 
TextProtocol Protocol Frame Format -
   specified text with the specified line ending and encoded with the
   specified encoding 
*/

class TextProtocol : public AbstractProtocol
{
public:
    enum textProtocolField
    {
        // Frame Fields
        textProto_text = 0,

        // Meta Fields
        textProto_portNum,
        textProto_eol,
        textProto_encoding,

        textProto_fieldCount
    };

    TextProtocol(StreamBase *stream, AbstractProtocol *parent = 0);
    virtual ~TextProtocol();

    static AbstractProtocol* createInstance(StreamBase *stream,
        AbstractProtocol *parent = 0);
    virtual quint32 protocolNumber() const;

    virtual void protoDataCopyInto(OstProto::Protocol &protocol) const;
    virtual void protoDataCopyFrom(const OstProto::Protocol &protocol);

    virtual quint32 protocolId(ProtocolIdType type) const;

    virtual QString name() const;
    virtual QString shortName() const;

    virtual int fieldCount() const;

    virtual AbstractProtocol::FieldFlags fieldFlags(int index) const;
    virtual QVariant fieldData(int index, FieldAttrib attrib,
               int streamIndex = 0) const;
    virtual bool setFieldData(int index, const QVariant &value, 
            FieldAttrib attrib = FieldValue);

    virtual int protocolFrameSize(int streamIndex = 0) const;

private:
    OstProto::TextProtocol    data;
};

#endif