instream.h

Go to the documentation of this file.

/*
    INSTREAM.H
    ----------
    Copyright (c) 2016 Andrew Trotman
    Released under the 2-clause BSD license (See:https://en.wikipedia.org/wiki/BSD_licenses)
*/
#pragma once

#include <vector>
#include <memory>

#include "document.h"
#include "allocator_memory.h"

namespace JASS
    {
    /*
        CLASS INSTREAM()
        ----------------
    */
    class instream
        {
        protected:
            std::shared_ptr<instream> source;       
            std::shared_ptr<allocator> memory;      

        public:
            /*
                INSTREAM::INSTREAM()
                --------------------
            */
            instream(std::shared_ptr<instream> &source, std::shared_ptr<allocator> &memory) :
                source(source),             // store the instream
                memory(memory)              // store the memory pointer
                {
                /* Nothing */
                }

            instream(std::shared_ptr<instream> &source) :
                source(source)                  // store the instream
                {
                /* Nothing */
                }

            /*
                INSTREAM::INSTREAM()
                --------------------
            */
            instream(void)
                {
                /* Nothing */
                }

            /*
                INSTREAM::~INSTREAM()
                ---------------------
            */
            virtual ~instream()
                {
                /* Nothing */
                }
    
            /*
                INSTREAM::READ()
                ----------------
            */
            virtual void read(document &buffer) = 0;
            
            /*
                INSTREAM::FETCH()
                -----------------
            */
            size_t fetch(void *buffer, size_t bytes)
                {
                allocator_memory provider(buffer, bytes);
                document into(provider);
                
                into.contents = slice(buffer, bytes);
                read(into);
                return into.contents.size();
                }
        } ;
    }