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 "document.h"
#include "allocator_memory.h"

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

        public:
            /*
                INSTREAM::INSTREAM()
                --------------------
            */
            instream(allocator *memory = nullptr, instream *source = nullptr) :
                memory(memory),             // store the memory pointer (which this object does not free on deletion)
                source(source)                  // store the instream (which this object does free on deletion)
                {
                }
            /*
                INSTREAM::~INSTREAM()
                ---------------------
            */
            virtual ~instream()
                {
                delete source;
                }
    
            /*
                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();
                }

        } ;
    }