stream.hpp

/*
 * libopenraw - stream.hpp
 *
 * Copyright (C) 2006-2020 Hubert Figuière
 *
 * 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 3 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, see
 * <http://www.gnu.org/licenses/>.
 */
 
 
#pragma once
 
#include <sys/types.h>
#include <stddef.h>
#include <stdint.h>
 
#include <memory>
#include <string>
 
#include <libopenraw/consts.h>
 
 
namespace OpenRaw {
namespace IO {
 
class Stream
{
public:
  typedef std::shared_ptr<Stream> Ptr;
  Stream(const char *filename);
  virtual ~Stream();
 
  Stream(const Stream& f) = delete;
  Stream & operator=(const Stream&) = delete;
 
  typedef ::or_error Error;
 
// file APIs
  virtual Error open() = 0;
  virtual int close() = 0;
  virtual int seek(off_t offset, int whence) = 0;
  virtual int read(void *buf, size_t count) = 0;
  virtual off_t filesize() = 0;
//          virtual void *mmap(size_t l, off_t offset) = 0;
//          virtual int munmap(void *addr, size_t l) = 0;
  Error get_error() const
    {
      return m_error;
    }
 
  const std::string &get_path() const
    {
      return m_fileName;
    }
 
  uint8_t readByte() noexcept(false);
protected:
  void set_error(Error error)
    {
      m_error = error;
    }
 
private:
  std::string m_fileName;
  Error m_error;
};
 
}
}
 
/*
  Local Variables:
  mode:c++
  c-file-style:"stroustrup"
  c-file-offsets:((innamespace . 0))
  tab-width:2
  c-basic-offset:2
  indent-tabs-mode:nil
  fill-column:80
  End:
*/