libcruft-util/alloc/raw/stack.hpp

/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Copyright 2015 Danny Robson <danny@nerdcruft.net>
 */

#ifndef CRUFT_UTIL_ALLOC_RAW_STACK_HPP
#define CRUFT_UTIL_ALLOC_RAW_STACK_HPP

#include "../../view.hpp"

#include <cstddef>


namespace util::alloc::raw {
    // allocate memory from a buffer in a stacklike manner. deallocation that
    // is not correctly ordered has undefined (read 'bad') results.
    class stack {
    public:
        stack (const stack&) = delete;
        stack (stack&&) = delete;
        stack& operator= (const stack&) = delete;
        stack& operator= (stack&&) = delete;

        stack (util::view<std::byte*> _data);

        util::view<std::byte*> allocate (size_t bytes, size_t alignment);
        util::view<std::byte*> allocate (size_t bytes);

        void deallocate (util::view<std::byte*> ptr) { return deallocate (ptr.data (), ptr.size ()); }
        void deallocate (util::view<std::byte*> ptr, size_t alignment) { return deallocate (ptr.data (), ptr.size (), alignment); }
        void deallocate (void *ptr, size_t bytes);
        void deallocate (void *ptr, size_t bytes, size_t alignment);

        util::view<std::byte*> data (void);
        util::view<const std::byte*> data (void) const;

        std::byte* begin (void);
        const std::byte* begin (void) const;

        std::byte* end (void);
        const std::byte* end (void) const;

        size_t offset (const void*) const;

        void reset (void);

        size_t capacity (void) const;
        size_t used     (void) const;
        size_t remain   (void) const;

    private:
        std::byte *const m_begin;
        std::byte *const m_end;
        std::byte *m_cursor;
    };
}

#endif