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_WrapperParser.h /* * gml/tcl/wrapper/wrapper/gmlTcl_WrapperParser.h -- * * See "gmlTclWrapperParser.cc". * * Copyright (c) 1996-2002 CLIPS-IMAG * * See the file "gml_LicenseTerms.txt" for information on usage and redistribution * of this file, and for a DISCLAIMER OF ALL WARRANTIES. * * Created on September 3, 2002 (FB). */ #ifndef __GMLTCLWRAPPERPARSER__ #define __GMLTCLWRAPPERPARSER__ #if defined(__cplusplus) extern "C" { #endif // required for "offsetof" #include <stddef.h> #include "gml/base/gml_Types.h" #include "tcl.h" #define gmlTcl_kMaxOptionNameLength 39 #define gmlTcl_kMaxDescrLength 79 /* * gmlTcl_TWrapParseProc -- * * Prototype of functions that convert Tcl_Objs to C/C++ data. * <interp> can be used to store an error message if the conversion is not possible. * <arg> is the Tcl_Obj to convert. * <storage> must be allocated by the caller, it must be big enough to contain the * C/C++ data. */ typedef int (gmlTcl_TWrapParseProc) (Tcl_Interp* interp, Tcl_Obj* arg, void* storage); /* * gmlTcl_gWrapParseInt -- * gmlTcl_gWrapParseIntList -- * gmlTcl_gWrapParseUInt8 -- * gmlTcl_gWrapParseUInt8List -- * gmlTcl_gWrapParseUInt16 -- * gmlTcl_gWrapParseUInt16List -- * gmlTcl_gWrapParseUInt32 -- * gmlTcl_gWrapParseUInt32List -- * gmlTcl_gWrapParseDouble -- * gmlTcl_gWrapParseDoubleList -- * gmlTcl_gWrapParseBoolean -- * gmlTcl_gWrapParseBooleanList -- * * Standard parsers. * In the case of a scalar value, a pointer to the converted value is stored in <*storage>, * followed immediately by the converted value. * In the case of a list, a pointer to an array of values is stored in <*storage>, * followed by the number of elements in the array (an int). The memory for the array * is allocated by "gml_Malloc", it is the responsability of the caller to free it with * "gml_Free". */ extern gmlTcl_TWrapParseProc* gmlTcl_gWrapParseInt; extern gmlTcl_TWrapParseProc* gmlTcl_gWrapParseIntList; extern gmlTcl_TWrapParseProc* gmlTcl_gWrapParseUInt8; extern gmlTcl_TWrapParseProc* gmlTcl_gWrapParseUInt8List; extern gmlTcl_TWrapParseProc* gmlTcl_gWrapParseUInt16; extern gmlTcl_TWrapParseProc* gmlTcl_gWrapParseUInt16List; extern gmlTcl_TWrapParseProc* gmlTcl_gWrapParseUInt32; extern gmlTcl_TWrapParseProc* gmlTcl_gWrapParseUInt32List; extern gmlTcl_TWrapParseProc* gmlTcl_gWrapParseDouble; extern gmlTcl_TWrapParseProc* gmlTcl_gWrapParseDoubleList; extern gmlTcl_TWrapParseProc* gmlTcl_gWrapParseFloat; extern gmlTcl_TWrapParseProc* gmlTcl_gWrapParseFloatList; extern gmlTcl_TWrapParseProc* gmlTcl_gWrapParseBoolean; extern gmlTcl_TWrapParseProc* gmlTcl_gWrapParseBooleanList; /* * gmlTcl_gWrapParseTclObj -- * * Don't parse, just return the Tcl_Obj*. */ extern gmlTcl_TWrapParseProc* gmlTcl_gWrapParseTclObj; /* * gmlTcl_gWrapParseString -- * * A pointer to the string is stored in <storage>. The memory is * managed by Tcl (and thus should not be freed by the caller), * it will exist as long as the Tcl_Object that produced the string. */ extern gmlTcl_TWrapParseProc* gmlTcl_gWrapParseString; /* * gmlTcl_gWrapParseStringList -- * * A pointer to an array of strings is stored in <storage>, followed by * an <int>. * It is the caller's responsability to free the array, but not the * individual strings (which are managed by Tcl). */ extern gmlTcl_TWrapParseProc* gmlTcl_gWrapParseStringList; /* * gmlTcl_TParamDescr -- * * <fName> is the name of the option. It typically starts with "-" such as "-color". * Set to empty "" if this is a required parameter. Required parameters * must be first in the array of gmlTcl_TParamDescr when passed to * <gmlTcl_WrapParse> (see below). * <fDescr> is a description of the parameter. It is used to generate an error message * that explain the form and semantic of parameters. * <fParseProc> is the parse function for this type of parameter. * <fResOffset> is the offset in the result buffer, in byte, where to store the converted data. */ typedef struct gmlTcl_TParamDescr { char fName[gmlTcl_kMaxOptionNameLength+1]; char fDescr[gmlTcl_kMaxDescrLength+1]; gmlTcl_TWrapParseProc* fParseProc; gml_TBlockSize fResOffset; } gmlTcl_TParamDescr; // Optional macro-constructors for gmlTcl_TParamDescr's #define GMLTCL_DECLARE_PARAM(FLAG,DESCRIPTION,PARSER,PROCNAME,FIELD) { FLAG, DESCRIPTION, gmlTcl_gWrapParse ## PARSER, offsetof (gmlTcl_ ## PROCNAME ## _params, FIELD) } #define GMLTCL_END_PARAM_LIST {"", "", (gmlTcl_TWrapParseProc*)NULL, 0 } /* * gmlTcl_WrapParse -- * * Parse Tcl word parameters into C/C++ data. * <interp> is used to store error message when necessary. * <paramDescrs> is the array of possible (accepted) parameters. * <objc>, <objv> are the Tcl words. * <argStart> is the index in the <objv> array where to start the parsing. * <gmlTcl_WrapParse> requires the entire Tcl command line in <objv> even * though parameter parsing typically doesn't start on the first words. The * first words are necessary to build the error message. * * <parseRes> is a pointer to the result buffer. The buffer is not initialized to zero. * Only the field corresponding to options in <objv> will be modified by * "gmlTcl_WrapParse". */ int gmlTcl_WrapParse (Tcl_Interp* interp, gmlTcl_TParamDescr* paramDescrs, int objc, Tcl_Obj* objv[], int argStart, void* parseRes); #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