OP/OP_Cache.h

Go to the documentation of this file.

#ifndef _OP_Cache_
#define _OP_Cache_

#include "OP_API.h"
#ifdef WIN32
    #include <sys/utime.h>
#else
    #include <time.h>
#endif

#include <UT/UT_Pointers.h>
#include <UT/UT_String.h>
#include "OP_Context.h"

class OP_CacheInfo;

enum OP_CacheOptions
{
    OP_CACHE_KEEP       // Tell the cache that it owns the pointer and data
};

typedef void  (*OP_Cache_Del_Func)(     void            *object,
                                        void            *data);

typedef void *(*OP_Cache_Copy_Func)(    void            *object,
                                        void            *data);

typedef void  (*OP_Cache_Eval_Func)(    OP_Context      &context,
                                        void            *eval_data,
                                        OP_Context      &eval_context,
                                        unsigned        &score,
                                        unsigned        &exact_match);

class OP_API OP_Cache : public UT_Pointers
{
public:
                 OP_Cache();
                 OP_Cache(      void                    *client,
                                const char              *cop_name,
                                const char              *cache_name,
                                OP_Cache_Del_Func        del_func);
                 OP_Cache(const OP_Cache &source);
                ~OP_Cache();

    void         setName(const char *copname, const char *cachename);
    void         setFunctions(  void                    *client,
                                OP_Cache_Del_Func        del_func);

    void         setSize(short size);
    short        getSize(void ) const { return( myMaxSize ); }

    void        *getData    (OP_Context &);
    void        *getDataEval(OP_Context &, OP_Cache_Eval_Func);

    void         putData(void                   *data,
                         OP_Context             &c,
                         OP_CacheOptions         o = OP_CACHE_KEEP);

    void        *stealData(void *, OP_Cache_Copy_Func);

    int          ownsData(void *);      // Does the cache own the data
    void         clear();               // Deletes all data in the cache.

    //
    // These are public; however, they're meant for diagnostics
    //

    void                 print(FILE *);
    OP_CacheInfo        *getInfo();
    const void          *getDataPtr(int slot);
    const OP_Context    *getContextPtr(int slot);

protected:

private:
    void                init();
    int                 deleteReference(void *);

    void                *myClient;
    UT_String            myOpName;
    UT_String            myCacheName;

    short                myCurrentSize;
    short                myMaxSize;

    OP_Cache_Del_Func    myDeleteFunc;
};

#endif

---