oaPlugInScriptInterfaces.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaPlugInScriptInterfaces.h
//
// This file contains the definitions for script interface classes, and public
// supporting objects. These include:
//
//  IBaseValue
//     This abstract class is the base interface for all values used in 
//     scripting. 
//
//  IScriptObserver
//     This is the interface for observing a script engine. Objects that 
//     this interface can be added as observers of an engine. 
//
//  IScriptEngine
//     This is an abstract class which specifies the interface for the script 
//     engine. This interface is used to perform actions by a script engine.
//
//  IValueTypeInfo
//     This interface describes a value type. It has methods to bind a void C++ 
//     pointer to a value object. 
//
//  IValueTypeLib
//     This interface represents a library of value types. It has a method to 
//     obtain the IValueTypeInfo object for a given type name. 
//
//  IValue
//     This template interface is used for all primitive values in scripting. 
//
//  ITypeValue
//     This interface is used for all values in scripting. 
//
// *****************************************************************************
// Except as specified in the OpenAccess terms of use of Cadence or Silicon
// Integration Initiative, this material may not be copied, modified,
// re-published, uploaded, executed, or distributed in any way, in any medium,
// in whole or in part, without prior written permission from Cadence.
//
//                Copyright 2002-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaPlugInScriptInterfaces_P)
#define oaPlugInScriptInterfaces_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaPlugInTypes.h"
#include "oaCommonSPtr.h"



// *****************************************************************************
// Declare and define types in the OpenAccess namespace.
// *****************************************************************************
BEGIN_OA_PLUGIN_NAMESPACE



// *****************************************************************************
// IBaseValue
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_IBaseValue;

class OA_PLUGIN_DLL_API IBaseValue : public IBase {
public:
    virtual const char      *getType() = 0;

    virtual SRef<IString>   toString() = 0;


    static const Guid       &getId();
};



// *****************************************************************************
// IValueIter
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_IValueIter;

// *****************************************************************************
// IValueIter
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_IValueIter;

class IValueIter : public IBase {
public:
    typedef IBaseValue      *Type;
    typedef IBaseValue      IType;

    virtual bool            next(IBaseValue *&objOut) = 0;
    virtual void            reset() = 0;

    static const Guid       &getId();
};



// *****************************************************************************
// IScriptObserver
// *****************************************************************************
class OA_PLUGIN_DLL_API IScriptObserver : public IBase {
public:
    virtual void            onOutput(const char *out) = 0;
};



// *****************************************************************************
// IScriptEngine
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_IScriptEngine;

class OA_PLUGIN_DLL_API IScriptEngine : public IBase {
public:
    typedef SRef<IBaseValue>    Value;

    virtual Value               eval(const char *code) = 0;

    virtual Value               eval(const char *fun,
                                     IValueIter *args) = 0;

    virtual void                setVariable(const char  *name,
                                            IBaseValue  *value) = 0;

    virtual Value               getVariable(const char *name) = 0;

    virtual void                defineProc(const char   *name,
                                           IBaseValue   *body) = 0;

    virtual void                undefineProc(const char *name) = 0;

    virtual void                addObserver(IScriptObserver *observer) = 0;

    virtual void                removeObserver(IScriptObserver *observer) = 0;


    static const Guid           &getId();
};



// *****************************************************************************
// IValueTypeInfo
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_IValueInfo;

class IValueTypeInfo : public IBase {
public:
    virtual SRef<IBaseValue>    bind(void *ptr) = 0;


    static const Guid           &getId();
};



// *****************************************************************************
// IValueTypeLib
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_IValueTypeLib;

class IValueTypeLib : public IBase {
public:
    virtual SRef<IValueTypeInfo>    getValueInfo(const char *name) = 0;


    static const Guid               &getId();
};



// *****************************************************************************
// IValue<T>
// *****************************************************************************
template<class T>
class IValue : public IBaseValue {
public:
    virtual T               getValue() = 0;

    virtual void            setValue(T value) = 0;


    static const Guid       &getId();
};



// *****************************************************************************
// ITypeValue
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_ITypeValue;

class ITypeValue : public IBaseValue {
public:
    virtual void            *getValue() = 0;

    virtual void            setValue(void *value) = 0;


    static const Guid       &getId();
};



// *****************************************************************************
// Value Interface GUID identifiers
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_ICharValue;
extern OA_PLUGIN_DLL_API const Guid IID_IByteValue;
extern OA_PLUGIN_DLL_API const Guid IID_IInt16Value;
extern OA_PLUGIN_DLL_API const Guid IID_IUInt16Value;
extern OA_PLUGIN_DLL_API const Guid IID_IInt32Value;
extern OA_PLUGIN_DLL_API const Guid IID_IUInt32Value;
extern OA_PLUGIN_DLL_API const Guid IID_IInt64Value;
extern OA_PLUGIN_DLL_API const Guid IID_IUInt64Value;

extern OA_PLUGIN_DLL_API const Guid IID_IStringValue;



// *****************************************************************************
// Type definitions for value interfaces
// *****************************************************************************
typedef IValue<char> ICharValue;
typedef IValue<unsigned char> IByteValue;
typedef IValue<oa::oaInt2> IInt16Value;
typedef IValue<oa::oaUInt2> IUInt16Value;
typedef IValue<oa::oaInt4> IInt32Value;
typedef IValue<oa::oaUInt4> IUInt32Value;
typedef IValue<oa::oaInt8> IInt64Value;
typedef IValue<oa::oaUInt8> IUInt64Value;

typedef IValue<const char*> IStringValue;


END_OA_PLUGIN_NAMESPACE

#endif

Return to top of page

Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.