RixInterfaces.h

Go to the documentation of this file.

/* $Id: //depot/main/rmanprod/rman/include/shadeop.h#18 $  (Pixar - RenderMan Division) $Date: 2005/06/02 $ */
/*
** Copyright (c) 2004 PIXAR.  All rights reserved.  This program or
** documentation contains proprietary confidential information and trade
** secrets of PIXAR.  Reverse engineering of object code is prohibited.
** Use of copyright notice is precautionary and does not imply
** publication.
**
**                      RESTRICTED RIGHTS NOTICE
**       
** Use, duplication, or disclosure by the Government is subject to the
** following restrictions:  For civilian agencies, subparagraphs (a) through
** (d) of the Commercial Computer Software--Restricted Rights clause at
** 52.227-19 of the FAR; and, for units of the Department of Defense, DoD
** Supplement to the FAR, clause 52.227-7013 (c)(1)(ii), Rights in
** Technical Data and Computer Software.
**
** Pixar
** 1200 Park Ave.
** Emeryville, CA  94608
*/

#ifndef RIX_INTERFACE_H
#define RIX_INTERFACE_H

#include <stddef.h>             // for size_t

enum RixInterfaceId {
    k_RixThreadUtils = 0,       
    k_RixMessages,              
    k_RixStats,                 
    k_RixGlobalData,            
    k_RixThreadData,            
    k_RixLocalData              
};


class RixInterface {
public:
    virtual int GetVersion() const { return m_version; }

protected:
    int m_version;

    RixInterface(int version) : m_version(version) { }

    virtual ~RixInterface() { }
};


class RixContext {
public:
    virtual RixInterface* GetRixInterface(RixInterfaceId id) const;

    virtual ~RixContext();
};


class RixMutex {
public:
    virtual ~RixMutex() { }

    virtual void Lock() = 0;
    
    virtual void Unlock() = 0;
};


class RixThreadUtils : public RixInterface {
public:
    virtual RixMutex* NewMutex() const = 0;

protected:
    RixThreadUtils() : RixInterface(1) { }
};


class RixMessages : public RixInterface {
public:
    virtual void Error(const char* format, ...) = 0;

    virtual void ErrorAlways(const char* format, ...) = 0;

    virtual void Warning(const char* format, ...) = 0;

    virtual void WarningAlways(const char* format, ...) = 0;

    virtual void Info(const char* format, ...) = 0;

    virtual void InfoAlways(const char* format, ...) = 0;

protected:
    RixMessages() : RixInterface(1) { }
};


class RixStats : public RixInterface {
public:
    virtual void AddTimerStat(float* seconds, const char* name,
                              const char* description) = 0;

    virtual void AddMemoryStat(size_t* bytes, const char* name, 
                               const char* description) = 0;

    typedef void (*Reporter)(class RixXmlFile* file);

    virtual void AddReporter(Reporter func) = 0;

protected:
    RixStats() : RixInterface(1) { }
};


class RixXmlFile {
public:
    virtual void WriteXml(const char* format, ...) = 0;

    virtual void WriteText(const char* format, ...) = 0;
};


typedef void (*RixCleanupFunc)(RixContext* context, void* data);


class RixStorage : public RixInterface {
public:
    virtual void* Get(const char* key) = 0;

    virtual void Set(const char* key, void* data, 
                     RixCleanupFunc cleanup = NULL) = 0;

    virtual void Clear(const char* key) = 0;

    virtual void Lock() = 0;

    virtual void Unlock() = 0;

protected:
    RixStorage() : RixInterface(1) { }
};


#endif  // RIX_INTERFACE_H

---