k3iobuffer.h

Go to the documentation of this file.

/*  -*- C++ -*-
 *  Copyright (C) 2003,2005 Thiago Macieira <thiago@kde.org>
 *
 *
 *  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 KIOBUFFER_H
#define KIOBUFFER_H

#include <kdecore_export.h>
#include <QtCore/QByteArray>


class KDECORE_EXPORT KIOBufferBase //krazy:exclude=inline (mainly virtual; simple implementations; KDE3 compat)
{
public:
  KIOBufferBase()
  { }

  KIOBufferBase(const KIOBufferBase& )
  { }

  virtual ~KIOBufferBase()
  { }

  KIOBufferBase& operator=(const KIOBufferBase& )
  { return *this; }

  virtual bool canReadLine() const = 0;

  virtual qint64 readLine(char* data, qint64 maxlen) = 0;

  virtual qint64 length() const = 0;

  inline bool isEmpty() const
  { return length() == 0; }

  virtual qint64 size() const = 0;

  inline bool isFull() const
  { return size() != -1 && size() == length(); }

  virtual bool setSize(qint64 size) = 0;

  virtual qint64 feedBuffer(const char *data, qint64 len) = 0;

  virtual qint64 consumeBuffer(char *data, qint64 maxlen, bool discard = true) = 0;

  virtual void clear() = 0;
};

#endif