cached_container.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright 2013-2017 CERN
 * @author Maciej Suminski <maciej.suminski@cern.ch>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */

#ifndef CACHED_CONTAINER_H_
#define CACHED_CONTAINER_H_

#include <gal/opengl/vertex_container.h>
#include <map>
#include <set>

namespace KIGFX
{
class VERTEX_ITEM;
class SHADER;

class CACHED_CONTAINER : public VERTEX_CONTAINER
{
public:
    CACHED_CONTAINER( unsigned int aSize = DEFAULT_SIZE );
    virtual ~CACHED_CONTAINER() {}

    bool IsCached() const override
    {
        return true;
    }

    virtual void SetItem( VERTEX_ITEM* aItem ) override;

    virtual void FinishItem() override;

    virtual VERTEX* Allocate( unsigned int aSize ) override;

    virtual void Delete( VERTEX_ITEM* aItem ) override;

    virtual void Clear() override;

    virtual unsigned int GetBufferHandle() const = 0;

    virtual bool IsMapped() const = 0;

    virtual void Map() override = 0;

    virtual void Unmap() override = 0;

protected:
    typedef std::pair<unsigned int, unsigned int> CHUNK;
    typedef std::multimap<unsigned int, unsigned int> FREE_CHUNK_MAP;

    typedef std::set<VERTEX_ITEM*> ITEMS;

    FREE_CHUNK_MAP  m_freeChunks;

    ITEMS m_items;

    VERTEX_ITEM* m_item;

    unsigned int m_chunkSize;
    unsigned int m_chunkOffset;

    unsigned int m_maxIndex;

    bool reallocate( unsigned int aSize );

    virtual bool defragmentResize( unsigned int aNewSize ) = 0;

    void defragment( VERTEX* aTarget );

    void mergeFreeChunks();

    inline int getChunkSize( const CHUNK& aChunk ) const
    {
        return aChunk.first;
    }

    inline unsigned int getChunkOffset( const CHUNK& aChunk ) const
    {
        return aChunk.second;
    }

    void addFreeChunk( unsigned int aOffset, unsigned int aSize );

private:
    void showFreeChunks();
    void showUsedChunks();
    void test();
};
} // namespace KIGFX

#endif /* CACHED_CONTAINER_H_ */