Home Page Toolkit Overview Using GML   User Input Services     Finger Tracker     Calibrator     Frame Grabber     Service protocol Obtaining GML   Installing GML   Licence Developer Documentation   Tcl/Tk API     The GML Canvas     Image processing   Tcl Scripts Library     List of Classes     List of Files   C/C++ API     List of Classes     List of Files

gmlTcl_Wrapper.h /* * gml/tcl/wrapper/wrapper/gmlTcl_Wrapper.h -- * * See "gmlTclWrapper.cc". * * Copyright (c) 1996-2003 CLIPS-IMAG * * See the file "gml_LicenseTerms.txt" for information on usage and redistribution * of this file, and for a DISCLAIMER OF ALL WARRANTIES. * * May 16, 2003 (FB) * hide wrapper structures, internals. * * September 8, 2002 (FB) * re-written for gml. * * Created on April 10, 1996 (FB). */ #ifndef __GMLTCLWRAPPER__ #define __GMLTCLWRAPPER__ #if defined(__cplusplus) extern "C" { #endif #include "tcl.h" #include "gml/base/gml_Types.h" #include "gml/base/gml_Callback.h" #include "gml/tcl/wrapper/wrapper/gmlTcl_WrapperParser.h" /* * gmlTclWrapper constant and globals -- */ #define gmlTcl_kMaxCommandNameLength 1024 #define gmlTcl_kClassMethodPrefix "--" /* * gmlTcl_TWrapClass -- * gmlTcl_TWrapObject -- * gmlTcl_TWrapEvent -- * * Opaque types representing, repectively, a wrapper of a class, a wrapper of an object, * and a wrapper of an event. */ typedef void* gmlTcl_TWrapClass; typedef void* gmlTcl_TWrapObject; typedef void* gmlTcl_TWrapEvent; /* * gmlTcl_WrapObject_GetNative -- * gmlTcl_WrapObject_SetNative -- * * Returns or set the native object of an object wrapper. */ void* gmlTcl_WrapObject_GetNative (gmlTcl_TWrapObject wrapObj); void gmlTcl_WrapObject_SetNative (gmlTcl_TWrapObject wrapObj, void* object); /* * gmlTcl_TWrapMethodProc -- * * Prototype of a function that wraps a "native" method call on an object. * <interp> is the interpreter in which the object exists. * <obj> is the object on which to call the method. * <objc>, <objv> contains the parameters of the call. * <parsedParams> points to the result of the parsing of the above parameters. */ typedef int (gmlTcl_TWrapMethodProc) (Tcl_Interp* interp, gmlTcl_TWrapObject wrapObj, int objc, Tcl_Obj*CONST objv[], void* parsedParams); /* * gmlTcl_TMethodDescr -- * * Informations for wrapping a method. * <fName> is the string name of the method (used in a Tcl command to call the method), * length must not be greater than <gmlTcl_kMaxCommandNameLength>. * <fMethodProc> is the method wrapper function. * <fParamDescrs> is an array, possibily empty (NULL), that tells which parameters are accepted * by this method and how to parse them (see "gml/tcl/wrapper/wrapper/gmlTcl_WrapperParser.h"). * If <NULL>, no processing is done on the parameters, it is the responsability * of <fMethodProc> to parse them. * <fResultSize> is the size, in byte, of the structure that stores the values resulting from * the parsing of the parameters. Used only if <fParamDescrs> is not NULL. */ typedef struct { char fName[gmlTcl_kMaxCommandNameLength+1]; gmlTcl_TWrapMethodProc* fMethodProc; gmlTcl_TParamDescr* fParamDescrs; gml_TBlockSize fResultSize; } gmlTcl_TMethodDescr; // Optional macro-constructors for gmlTcl_TMethodDescr's #define GMLTCL_DECLARE_METHOD(CLASS,METHOD) { #METHOD, &gmlTcl_ ## CLASS ## _ ## METHOD, gmlTcl_g ## CLASS ## _ ## METHOD ## _descr, sizeof (gmlTcl_ ## CLASS ## _ ## METHOD ## _params) } #define GMLTCL_END_METHOD_LIST {"", (gmlTcl_TWrapMethodProc *) NULL, (gmlTcl_TParamDescr *) NULL, 0} /* * gmlTcl_WrapClass_New -- * * Create the wrapping for a class of object into a Tcl interpreter. * <interp> is the interpreter in which the class wrapper is created. * <className> is the string for the Tcl command that creates objects of this class, * length must not be greater than <gmlTcl_kMaxCommandNameLength>. * <methodDescrs> is the array of method-wrappers of this class. * The array must contain a "constructor" method to allow instanciation * of objects of this class. The "constructor" function wrapper must * allocate a native (C++) object and associate it with the object * wrapper with "gmlTcl_WrapObject_SetNative". * If there is no "constructor" method in the array, this is a * pure virtual class: no instance can be created, the class is only * used by inheritance. * If the array contains a "destructor" method, it is invoked when an * instance is deleted. The destructor has the responsability to delete * the native (C++) object. * * <classWrap> on return, is set to the class wrapper token. */ int gmlTcl_WrapClass_New (Tcl_Interp* interp, char* className, gmlTcl_TMethodDescr* methodDescrs, gmlTcl_TWrapClass* classWrap); /* * gmlTcl_WrapClass_Delete -- * * Deletes a class wrapper from an interpreter. * <classWrap> class wrapper token, returned by <gmlTcl_WrapClass_New>. */ void gmlTcl_WrapClass_Delete (gmlTcl_TWrapClass classWrap); /* * gmlTcl_WrapClass_StrName -- * * Returns the string name of the wrapped class <wrapClass>. */ char* gmlTcl_WrapClass_StrName (gmlTcl_TWrapObject wrapClass); /* * gmlTcl_WrapClass_Inherit -- * * Arrange for <specialized> to inherit from <super> methods. */ int gmlTcl_WrapClass_Inherit (Tcl_Interp* interp, gmlTcl_TWrapClass specialized, gmlTcl_TWrapClass super); /* * gmlTcl_WrapClass_DeInherit -- * * Arrange for <specialized> to loose inheritance from <super>. */ void gmlTcl_WrapClass_DeInherit (gmlTcl_TWrapClass specialized, gmlTcl_TWrapClass super); /* * gmlTcl_WrapClass_ObjectFromName -- * * Returns in <object> the object wrapper for the object named <objName> which class * is <wrapClass> or one of its specializations. * If there is no such object, TCL_ERROR is returned and an error message is left in * <interp>. */ int gmlTcl_WrapClass_ObjectFromName (Tcl_Interp* interp, gmlTcl_TWrapClass wrapClass, char* objName, gmlTcl_TWrapObject* object); /* * gmlTcl_WrapObject_NewWrapper -- * * Create an object wrapper for the low-level object <object> from the class <wrapClass>. * The low-level object must be already constructed. Thus, the constructor is not called, * and the destructor will not be called when the wrapper will be deleted (for example, * when its associated tcl command is deleted). It is the responsability of the called * to delete the low-level object. * * If <ownerRef> is not NULL, it is a pointer to the owner's reference to the new object * wrapper. It is stored so that, when the wrapper will be deleted, the reference will * be set to NULL (so that the owner knows that the wrapper has been deleted). * * If <owner> is not NULL, it is the wrapper of the object that owns the new object. When * <owner> will be deleted, this new wrapper will be deleted also. When <owner> is not * NULL, <ownerRef> is ignored. */ int gmlTcl_WrapObject_NewWrapper (Tcl_Interp* interp, gmlTcl_TWrapClass wrapClass, char* objName, void* object, gmlTcl_TWrapObject* ownerRef, gmlTcl_TWrapObject owner); /* * gmlTcl_WrapObject_DeleteWrapper -- */ void gmlTcl_WrapObject_DeleteWrapper (gmlTcl_TWrapObject wrapObj); /* * gmlTcl_WrapObject_StrName -- * * Returns the string name of the wrapped object <wrapObj>. */ char* gmlTcl_WrapObject_StrName (gmlTcl_TWrapObject wrapObj); /* * gmlTcl_WrapBinding_AddEvent -- * * Add a new event named <eventName> to the list of event that can be bound to * the class <wrapClass> or to objects of the class <wrapClass> depending on * <isAClassEvent>: if <isAClassEvent> is true this is a class event than can * be bound to by calling the "--bind" class method, otherwise it is an object * event that is bound to by calling the "bind" method on the object. * * A handle to the event is returned in <wrapEvent>, it will be used to invoke * the event with "gmlTcl_WrapperBinding_Invoke" or to remove the event. */ int gmlTcl_WrapBinding_AddEvent (Tcl_Interp* interp, gmlTcl_TWrapClass wrapClass, gml_TBoolean isAClassEvent, char* eventName, gmlTcl_TWrapEvent* wrapEvent); /* * gmlTcl_WrapBinding_RemoveEvent -- * * Remove the event from the list. */ void gmlTcl_WrapBinding_RemoveEvent (gmlTcl_TWrapEvent wrapEvent); /* * gmlTcl_WrapBinding_Invoke -- * * Evaluate every script bound to the event <wrapEvent>. If this event is an * object event, then the object must be provided in <wrapObj>, otherwise * <wrapObj> is ignored. * If <async> is true, the callbacks will not be called immediately, they will be * called when it is safe to do so (at the end of the evaluation of a Tcl command) * using Tcl asynchronous mechanism (cf. "Tcl_AsyncCreate"). * The <objc> parameters stored in <objv> are added at the end of the scripts * before evaluation. * * If a callback script generate an error, it is removed from this list of bound scripts. * Returns TCL_OK, or TCL_ERROR only in the case of a failed async invoke because their was * no more memory to schedule the invoke. */ int gmlTcl_WrapBinding_Invoke (gmlTcl_TWrapEvent wrapEvent, gmlTcl_TWrapObject wrapObj, gml_TBoolean async, int objc, Tcl_Obj* objv[]); #if defined(__cplusplus) } #endif #endif Generated on Tue Jun 12 14:03:27 2007 for gml by Doxygen 1.5.2.

Contact: julien (dot) letessier (at) gmail (dot) com. Copyright (c) 2000-2007 CLIPS-IMAG Laboratory, Grenoble, France. All rights reserved. W3CXHTML 1.0 W3CCSS 2.0