io.h

Go to the documentation of this file.

#ifndef PRESSIO_IO_PLUGIN_H
#define PRESSIO_IO_PLUGIN_H
#include <string>
#include <memory>
#include "configurable.h"
#include "versionable.h"
#include "errorable.h"
#include <std_compat/span.h>
 
struct pressio_data;
 
struct libpressio_io_plugin: public pressio_configurable, public pressio_versionable {
  public:
 
  virtual ~libpressio_io_plugin()=default;
 
  struct pressio_data* read(struct pressio_data* data);
 
  template <class ContigIterator>
  int read_many(ContigIterator data_begin, ContigIterator data_end) {
    clear_error();
    compat::span<struct pressio_data*> data(data_begin, data_end);
    return read_many_impl(data);
  }
 
  int write(struct pressio_data const* data);
 
  template <class ContigIterator>
  int write_many(ContigIterator data_begin, ContigIterator data_end) {
    clear_error();
    compat::span<const struct pressio_data*> data(data_begin, data_end);
    return write_many_impl(data);
  }
 
  int check_options(struct pressio_options const&) override final;
 
  int set_options(struct pressio_options const& options) override final;
  struct pressio_options get_documentation() const override final;
  struct pressio_options get_configuration() const override final;
  struct pressio_options get_options() const override final;
 
  virtual std::shared_ptr<libpressio_io_plugin> clone()=0;
 
  void set_name(std::string const& new_name) final;
 
 
  protected:
 
  virtual int check_options_impl(struct pressio_options const&);
 
  virtual pressio_data* read_impl(struct pressio_data* data)=0;
 
  virtual int write_impl(struct pressio_data const* data)=0;
 
  virtual int read_many_impl(compat::span<struct pressio_data*> const& data) { 
    (void)data;
    return set_error(1, "read many not supported");
  }
 
  virtual int write_many_impl(compat::span<struct pressio_data const*> const& data) {
    (void)data;
    return set_error(1, "write many not supported");
  }
 
  virtual struct pressio_options get_documentation_impl() const=0;
 
  virtual struct pressio_options get_configuration_impl() const=0;
 
  virtual int set_options_impl(struct pressio_options const& options)=0;
 
  virtual struct pressio_options get_options_impl() const=0;
 
  private:
};
 
struct pressio_io {
  pressio_io(std::unique_ptr<libpressio_io_plugin>&& impl): plugin(std::forward<std::unique_ptr<libpressio_io_plugin>>(impl)) {}
  pressio_io(std::shared_ptr<libpressio_io_plugin>&& impl): plugin(std::forward<std::shared_ptr<libpressio_io_plugin>>(impl)) {}
  pressio_io()=default;
  pressio_io(pressio_io const& io): plugin(io->clone()) {}
  pressio_io& operator=(pressio_io const& io) {
    if(&io == this) return *this;
    plugin = io->clone();
    return *this;
  }
  pressio_io(pressio_io&& io)=default;
  pressio_io& operator=(pressio_io&& io)=default;
 
  operator bool() const {
    return bool(plugin);
  }
 
  libpressio_io_plugin& operator*() const noexcept {
    return *plugin;
  }
 
  libpressio_io_plugin* operator->() const noexcept {
    return plugin.get();
  }
 
  std::shared_ptr<libpressio_io_plugin> plugin;
};
 
#endif /* end of include guard: PRESSIO_IO_PLUGIN_H */