IOChannel.h

Go to the documentation of this file.

// IOChannel.h - a virtual IO channel, for Gnash
// 
//   Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
//   Free Software Foundation, Inc
// 
// This program 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, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA


#ifndef GNASH_IOCHANNEL_H
#define GNASH_IOCHANNEL_H

#include <string>
#include <ios> // for std::streamsize
#include <cstdint> // for boost int types

#include "dsodefs.h" // DSOEXPORT
#include "GnashException.h" // for IOException inheritance

namespace gnash {

class DSOEXPORT IOException : public GnashException
{
public:
    IOException(const std::string& s) : GnashException(s) {}
    IOException() : GnashException("IO error") {}
};

class DSOEXPORT IOChannel
{
public:

    virtual ~IOChannel() {}

    //
    std::uint32_t read_le32();

    //
    std::uint16_t read_le16();

    //
    std::uint8_t read_byte();
    
    //
    virtual std::streamsize read(void* dst, std::streamsize num)=0;

    //
    virtual std::streamsize readNonBlocking(void* dst, std::streamsize num)
    {
        return read(dst, num);
    }

    //
    virtual std::streamsize write(const void* src, std::streamsize num);

    //
    int    read_string(char* dst, int max_length);
    
    //
    virtual std::streampos tell() const = 0;

    //
    virtual bool seek(std::streampos p) = 0;

    //
    virtual void go_to_end() = 0;

    //
    virtual bool eof() const = 0;
    
    //
    virtual bool bad() const = 0;
    
    //
    virtual size_t size() const { return static_cast<size_t>(-1); }
   
};

} // namespace gnash

#endif // GNASH_IOCHANNEL_H


// Local Variables:
// mode: C++
// indent-tabs-mode: t
// End: