IOAccessor.h

Go to the documentation of this file.

/*
 * IOAccessor.h
 *
 * Smalltalk like class library for C++
 * Abstract accessor to I/O resource. Header.
 *
 * Copyright (c) 2003 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 __IOACCESSOR_H
#define __IOACCESSOR_H

#include <stlib/Object.h>
#include <stlib/LineEndConvention.h>

namespace Core {

class ByteArray;
class ExternalEncodedStreamFactory;
class ExternalReadStream;
class ExternalReadAppendStream;
class ExternalWriteStream;
class String;

class IOAccessor : public Object
{
  public:
    /* Class-accessing protocol */
    virtual String *className(void) const;

    /* Initialize-release protocol */
    virtual void close(void) abstract;

    /* Accessing protocol */
    virtual long bufferSize(void);
    virtual void commit(void);
    virtual long dataSize(void);
    virtual LineEndConvention lineEndConvention(void);

    /* Data transfer protocol */
    virtual int readInto(ByteArray *buffer);
    virtual int readInto(ByteArray *buffer, long startIndex, long count) abstract;

    virtual int writeFrom(ByteArray *buffer);
    virtual int writeFrom(ByteArray *buffer, long startIndex, long count) abstract;

    virtual int writeForSureFrom(ByteArray *buffer, long startIndex, long count);

    /* Positioning protocol */
    virtual void seekTo(long position) abstract;

    /* Synchronization protocol */
    virtual void readWait(void);
    virtual void writeWait(void);

    /* Stream creation protocol */
    virtual ExternalReadStream *readStream(void);
    virtual ExternalReadAppendStream *readAppendStream(void);
    virtual ExternalWriteStream *writeStream(void);
    virtual ExternalEncodedStreamFactory *withEncoding(String *encoding);
    virtual ExternalEncodedStreamFactory *withEncoding(const char *encoding);

    /* Stream redirection protocol */
    virtual void changeDescriptorTo(int fd);

    /* Testing protocol */
    virtual bool isSeekable(void);
};

};

#endif /* __IOACCESSOR_H */

---