Stream.h

Go to the documentation of this file.

/*
 * Stream.h
 *
 * Smalltalk like class library for C++
 * Abstract stream. Header.
 *
 * Copyright (c) 2003-6 Milan Cermak
 */
/*
 * This library 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.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
#ifndef __STREAM_H
#define __STREAM_H

#include <stlib/Object.h>

namespace Core {

class Character;
class Collection;
class Integer;
class SequenceableCollection;

class Stream : public Object
{
  public:

    /* Accessing protocol */
    virtual Stream *basicStream(void);
    virtual SequenceableCollection *contents(void) abstract;
    virtual void flush(void) abstract;
    virtual Object *next(void) abstract;
    virtual SequenceableCollection *next(long items);
    virtual SequenceableCollection *next(long items, SequenceableCollection *newColl, long index);
    virtual SequenceableCollection *nextLine(void);
    virtual Integer *nextBigEndianLong(void);
    virtual Integer *nextBigEndianShort(void);
    virtual Integer *nextLittleEndianLong(void);
    virtual Integer *nextLittleEndianShort(void);

    virtual void nextPut(Object *object) abstract;
    virtual void nextPut(const char object);
    virtual void nextPutAll(const Collection *collection);
    virtual void nextPutAll(const char *string);
    virtual void nextPutAll(const SequenceableCollection *collection,
                            long size, long startIndex);
    virtual void nextPutBigEndianLong(Integer *number);
    virtual void nextPutBigEndianLong(unsigned long int number);
    virtual void nextPutBigEndianShort(Integer *number);
    virtual void nextPutBigEndianShort(unsigned short int number);
    virtual void nextPutLittleEndianLong(Integer *number);
    virtual void nextPutLittleEndianLong(unsigned long int number);
    virtual void nextPutLittleEndianShort(Integer *number);
    virtual void nextPutLittleEndianShort(unsigned short int number);

    virtual SequenceableCollection *upTo(Object *object);
    virtual SequenceableCollection *upToAll(SequenceableCollection *sequence);
    virtual SequenceableCollection *upToAny(Collection *collection);
    virtual SequenceableCollection *upToEnd(void);
    virtual SequenceableCollection *upToSeparator(void);

    virtual Object *peek(void);

    /* Character reading protocol */
    virtual void skipSeparators(void);

    /* Character writing protocol */
    virtual void cr(void);
    virtual void lf(void);
    virtual void space(void);
    virtual void tab(void);

    /* Error handling protocol */
    virtual void positionOutOfBoundsError(String *selector, int position);

    /* Positioning protocol */
    virtual long position(void) abstract;
    virtual void position(long position) abstract;
    virtual void reset(void) abstract;
    virtual void skip(long length) abstract;

    /* Printing protocol */
    virtual void print(Object *object);
    virtual void print(long number);
    virtual void print(double number);

    /* Status protocol */
    virtual void close(void);
    virtual void commit(void);

    /* Testing protocol */
    virtual bool atEnd(void) abstract;
    virtual bool basicAtEnd(void) abstract;
    virtual bool isEmpty(void) abstract;
    virtual bool notEmpty(void) abstract;
    virtual bool isBinary(void) abstract;
    virtual bool isExternalStream(void);
    virtual bool isReadable(void) abstract;
    virtual bool isWritable(void) abstract;

  protected:
    /* Private protocol */
    virtual SequenceableCollection *contentSpeciesFor(long items);
};

};

#endif /* __STREAM_H */

---