QSDK 1.1 Documentation

allocator.h

Go to the documentation of this file.

/*-
 * Copyright (c) 2001-2003 Qube Software, Ltd.
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 * 
 * 1. Redistributions of the source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 
 * 2. Any redistribution solely in binary form must conspicuously
 *    reproduce the following disclaimer in documentation provided with the
 *    binary redistribution.
 * 
 * THIS SOFTWARE IS PROVIDED ``AS IS'', WITHOUT ANY WARRANTIES, EXPRESS
 * OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  LICENSOR SHALL
 * NOT BE LIABLE FOR ANY LOSS OR DAMAGES RESULTING FROM THE USE OF THIS
 * SOFTWARE, EITHER ALONE OR IN COMBINATION WITH ANY OTHER SOFTWARE.
 * 
 *      $Qube: Q/utils/sdk/allocator.h,v 1.21 2003/06/19 12:50:38 peterj Exp $
 */


#ifndef __allocator_h__
#define __allocator_h__

#include <Q/linkage.h>

#ifndef UTILS_BEGIN
#define UTILS_BEGIN    namespace Utils {
#define UTILS_END      }
#endif

#include <Q/utils.h>

UTILS_BEGIN

struct EXPORT_QUTILS Allocator
{
    virtual void*               alloc(size_t size) = 0;
    virtual void                free(void* p) = 0;
    virtual size_t              size(void* p) const = 0;
    virtual size_t              allocatedMemory() const = 0;
    virtual void*               alloc(size_t amt, unsigned int color) 
                                        { return alloc(amt); }
    virtual size_t              internalFree() const = 0;
    virtual unsigned int        color(void*) const { return 0; }
    virtual Utils::Result       setColor(void*, unsigned int) 
                                        { return Utils::NotImplemented; }
    virtual bool                valid(void*) const { return false; }
    virtual Utils::Result       setDefaultColor(unsigned int col,
                                                unsigned int* oldCol)
                                        { return Utils::NotImplemented; }
    virtual unsigned int        defaultColor() const { return 0; }
    virtual size_t              allocatedColorMemory(unsigned int col) const
                                        { return 0; }
    virtual size_t              freeColorMemory(unsigned int col) const
                                        { return 0; }
    virtual void                adjustColorMemory(unsigned int col, int amt)
                                        {};

    static Allocator*           theAllocator();
};

struct EXPORT_QUTILS HostAllocator: public Allocator
{
    virtual void*               alloc(size_t);
    virtual void                free(void*) {}
    virtual size_t              size(void*) const;
    virtual size_t              allocatedMemory() const { return 0; }
    virtual void*               alloc(size_t x, char type) { return alloc(x); }
    virtual size_t              internalFree() const { return 0; }

private:

    size_t                      lastBlockSize_;
};


struct EXPORT_QUTILS MemoryColor
{
                                MemoryColor(unsigned int col);

                                ~MemoryColor() { reset(); }

    unsigned int                lastColor() const { return lastColor_; }


    void                        reset();
    
private:

    unsigned int                lastColor_;
};


UTILS_END

#endif /* __allocator_h__ */

		Qube Software Limited © 2000-2004