Section 3: library functions
Tcl_GetOpenFile – Return a FILE* for a channel registered in the given interpreter (Unix only) Synopsis#include <tcl.h> int Tcl_GetOpenFile(interp, chanID, write, checkUsage, filePtr)ArgumentsTcl_Interp *interp (in) Tcl interpreter from which file handle is to be obtained. const char *chanID (in) String identifying channel, such as stdin or file4. int write (in) Non-zero means the file will…
Tcl_ClassGetMetadata, Tcl_ClassSetMetadata, Tcl_CopyObjectInstance, Tcl_GetClassAsObject, Tcl_GetObjectAsClass, Tcl_GetObjectCommand, Tcl_GetObjectFromObj, Tcl_GetObjectName, Tcl_GetObjectNamespace, Tcl_NewObjectInstance, Tcl_ObjectDeleted, Tcl_ObjectGetMetadata, Tcl_ObjectGetMethodNameMapper, Tcl_ObjectSetMetadata, Tcl_ObjectSetMethodNameMapper – manipulate objects and classes Synopsis#include <tclOO.h> Tcl_Object Tcl_GetObjectFromObj(interp, objPtr) Tcl_Object Tcl_GetClassAsObject(class) Tcl_Class Tcl_GetObjectAsClass(object) Tcl_Obj * Tcl_GetObjectName(interp, object) Tcl_Command Tcl_GetObjectCommand(object) Tcl_Namespace * Tcl_GetObjectNamespace(object) Tcl_Object Tcl_NewObjectInstance(interp, class, name, nsName, objc, objv, skip) Tcl_Object Tcl_CopyObjectInstance(interp, object, name, nsName) int Tcl_ObjectDeleted(object) ClientData Tcl_ObjectGetMetadata(object,…
Tcl_ClassGetMetadata, Tcl_ClassSetMetadata, Tcl_CopyObjectInstance, Tcl_GetClassAsObject, Tcl_GetObjectAsClass, Tcl_GetObjectCommand, Tcl_GetObjectFromObj, Tcl_GetObjectName, Tcl_GetObjectNamespace, Tcl_NewObjectInstance, Tcl_ObjectDeleted, Tcl_ObjectGetMetadata, Tcl_ObjectGetMethodNameMapper, Tcl_ObjectSetMetadata, Tcl_ObjectSetMethodNameMapper – manipulate objects and classes Synopsis#include <tclOO.h> Tcl_Object Tcl_GetObjectFromObj(interp, objPtr) Tcl_Object Tcl_GetClassAsObject(class) Tcl_Class Tcl_GetObjectAsClass(object) Tcl_Obj * Tcl_GetObjectName(interp, object) Tcl_Command Tcl_GetObjectCommand(object) Tcl_Namespace * Tcl_GetObjectNamespace(object) Tcl_Object Tcl_NewObjectInstance(interp, class, name, nsName, objc, objv, skip) Tcl_Object Tcl_CopyObjectInstance(interp, object, name, nsName) int Tcl_ObjectDeleted(object) ClientData Tcl_ObjectGetMetadata(object,…
Tcl_ClassGetMetadata, Tcl_ClassSetMetadata, Tcl_CopyObjectInstance, Tcl_GetClassAsObject, Tcl_GetObjectAsClass, Tcl_GetObjectCommand, Tcl_GetObjectFromObj, Tcl_GetObjectName, Tcl_GetObjectNamespace, Tcl_NewObjectInstance, Tcl_ObjectDeleted, Tcl_ObjectGetMetadata, Tcl_ObjectGetMethodNameMapper, Tcl_ObjectSetMetadata, Tcl_ObjectSetMethodNameMapper – manipulate objects and classes Synopsis#include <tclOO.h> Tcl_Object Tcl_GetObjectFromObj(interp, objPtr) Tcl_Object Tcl_GetClassAsObject(class) Tcl_Class Tcl_GetObjectAsClass(object) Tcl_Obj * Tcl_GetObjectName(interp, object) Tcl_Command Tcl_GetObjectCommand(object) Tcl_Namespace * Tcl_GetObjectNamespace(object) Tcl_Object Tcl_NewObjectInstance(interp, class, name, nsName, objc, objv, skip) Tcl_Object Tcl_CopyObjectInstance(interp, object, name, nsName) int Tcl_ObjectDeleted(object) ClientData Tcl_ObjectGetMetadata(object,…
Tcl_ClassGetMetadata, Tcl_ClassSetMetadata, Tcl_CopyObjectInstance, Tcl_GetClassAsObject, Tcl_GetObjectAsClass, Tcl_GetObjectCommand, Tcl_GetObjectFromObj, Tcl_GetObjectName, Tcl_GetObjectNamespace, Tcl_NewObjectInstance, Tcl_ObjectDeleted, Tcl_ObjectGetMetadata, Tcl_ObjectGetMethodNameMapper, Tcl_ObjectSetMetadata, Tcl_ObjectSetMethodNameMapper – manipulate objects and classes Synopsis#include <tclOO.h> Tcl_Object Tcl_GetObjectFromObj(interp, objPtr) Tcl_Object Tcl_GetClassAsObject(class) Tcl_Class Tcl_GetObjectAsClass(object) Tcl_Obj * Tcl_GetObjectName(interp, object) Tcl_Command Tcl_GetObjectCommand(object) Tcl_Namespace * Tcl_GetObjectNamespace(object) Tcl_Object Tcl_NewObjectInstance(interp, class, name, nsName, objc, objv, skip) Tcl_Object Tcl_CopyObjectInstance(interp, object, name, nsName) int Tcl_ObjectDeleted(object) ClientData Tcl_ObjectGetMetadata(object,…
Tcl_ClassGetMetadata, Tcl_ClassSetMetadata, Tcl_CopyObjectInstance, Tcl_GetClassAsObject, Tcl_GetObjectAsClass, Tcl_GetObjectCommand, Tcl_GetObjectFromObj, Tcl_GetObjectName, Tcl_GetObjectNamespace, Tcl_NewObjectInstance, Tcl_ObjectDeleted, Tcl_ObjectGetMetadata, Tcl_ObjectGetMethodNameMapper, Tcl_ObjectSetMetadata, Tcl_ObjectSetMethodNameMapper – manipulate objects and classes Synopsis#include <tclOO.h> Tcl_Object Tcl_GetObjectFromObj(interp, objPtr) Tcl_Object Tcl_GetClassAsObject(class) Tcl_Class Tcl_GetObjectAsClass(object) Tcl_Obj * Tcl_GetObjectName(interp, object) Tcl_Command Tcl_GetObjectCommand(object) Tcl_Namespace * Tcl_GetObjectNamespace(object) Tcl_Object Tcl_NewObjectInstance(interp, class, name, nsName, objc, objv, skip) Tcl_Object Tcl_CopyObjectInstance(interp, object, name, nsName) int Tcl_ObjectDeleted(object) ClientData Tcl_ObjectGetMetadata(object,…
Tcl_RegisterObjType, Tcl_GetObjType, Tcl_AppendAllObjTypes, Tcl_ConvertToType – manipulate Tcl object types Synopsis#include <tcl.h> Tcl_RegisterObjType(typePtr) Tcl_ObjType * Tcl_GetObjType(typeName) int Tcl_AppendAllObjTypes(interp, objPtr) int Tcl_ConvertToType(interp, objPtr, typePtr)ArgumentsTcl_ObjType *typePtr (in) Points to the structure containing information about the Tcl object type. This storage must live forever, typically by being statically allocated. const char *typeName (in) The name of a Tcl object…
Tcl_SetObjResult, Tcl_GetObjResult, Tcl_SetResult, Tcl_GetStringResult, Tcl_AppendResult, Tcl_AppendResultVA, Tcl_AppendElement, Tcl_ResetResult, Tcl_FreeResult – manipulate Tcl result Synopsis#include <tcl.h> Tcl_SetObjResult(interp, objPtr) Tcl_Obj * Tcl_GetObjResult(interp) Tcl_SetResult(interp, result, freeProc) const char * Tcl_GetStringResult(interp) Tcl_AppendResult(interp, result, result, … , (char *) NULL) Tcl_AppendResultVA(interp, argList) Tcl_AppendElement(interp, element) Tcl_ResetResult(interp) Tcl_FreeResult(interp)ArgumentsTcl_Interp *interp (out) Interpreter whose result is to be modified or read. Tcl_Obj *objPtr (in)…
Tcl_AppendExportList, Tcl_CreateNamespace, Tcl_DeleteNamespace, Tcl_Export, Tcl_FindCommand, Tcl_FindNamespace, Tcl_ForgetImport, Tcl_GetCurrentNamespace, Tcl_GetGlobalNamespace, Tcl_GetNamespaceUnknownHandler, Tcl_Import, Tcl_SetNamespaceUnknownHandler – manipulate namespaces Synopsis#include <tcl.h> Tcl_Namespace * Tcl_CreateNamespace(interp, name, clientData, deleteProc) Tcl_DeleteNamespace(nsPtr) int Tcl_AppendExportList(interp, nsPtr, objPtr) int Tcl_Export(interp, nsPtr, pattern, resetListFirst) int Tcl_Import(interp, nsPtr, pattern, allowOverwrite) int Tcl_ForgetImport(interp, nsPtr, pattern) Tcl_Namespace * Tcl_GetCurrentNamespace(interp) Tcl_Namespace * Tcl_GetGlobalNamespace(interp) Tcl_Namespace * Tcl_FindNamespace(interp, name, contextNsPtr, flags) Tcl_Command…
Tcl_FindExecutable, Tcl_GetNameOfExecutable – identify or return the name of the binary file containing the application Synopsis#include <tcl.h> void Tcl_FindExecutable(argv0) const char * Tcl_GetNameOfExecutable()Argumentschar *argv0 (in) The first command-line argument to the program, which gives the application’s name. DescriptionThe Tcl_FindExecutable procedure computes the full path name of the executable file from which the application was invoked…
Tcl_FSRegister, Tcl_FSUnregister, Tcl_FSData, Tcl_FSMountsChanged, Tcl_FSGetFileSystemForPath, Tcl_FSGetPathType, Tcl_FSCopyFile, Tcl_FSCopyDirectory, Tcl_FSCreateDirectory, Tcl_FSDeleteFile, Tcl_FSRemoveDirectory, Tcl_FSRenameFile, Tcl_FSListVolumes, Tcl_FSEvalFile, Tcl_FSEvalFileEx, Tcl_FSLoadFile, Tcl_FSUnloadFile, Tcl_FSMatchInDirectory, Tcl_FSLink, Tcl_FSLstat, Tcl_FSUtime, Tcl_FSFileAttrsGet, Tcl_FSFileAttrsSet, Tcl_FSFileAttrStrings, Tcl_FSStat, Tcl_FSAccess, Tcl_FSOpenFileChannel, Tcl_FSGetCwd, Tcl_FSChdir, Tcl_FSPathSeparator, Tcl_FSJoinPath, Tcl_FSSplitPath, Tcl_FSEqualPaths, Tcl_FSGetNormalizedPath, Tcl_FSJoinToPath, Tcl_FSConvertToPathType, Tcl_FSGetInternalRep, Tcl_FSGetTranslatedPath, Tcl_FSGetTranslatedStringPath, Tcl_FSNewNativePath, Tcl_FSGetNativePath, Tcl_FSFileSystemInfo, Tcl_GetAccessTimeFromStat, Tcl_GetBlockSizeFromStat, Tcl_GetBlocksFromStat, Tcl_GetChangeTimeFromStat, Tcl_GetDeviceTypeFromStat, Tcl_GetFSDeviceFromStat, Tcl_GetFSInodeFromStat, Tcl_GetGroupIdFromStat, Tcl_GetLinkCountFromStat, Tcl_GetModeFromStat, Tcl_GetModificationTimeFromStat, Tcl_GetSizeFromStat, Tcl_GetUserIdFromStat,…
Tcl_FSRegister, Tcl_FSUnregister, Tcl_FSData, Tcl_FSMountsChanged, Tcl_FSGetFileSystemForPath, Tcl_FSGetPathType, Tcl_FSCopyFile, Tcl_FSCopyDirectory, Tcl_FSCreateDirectory, Tcl_FSDeleteFile, Tcl_FSRemoveDirectory, Tcl_FSRenameFile, Tcl_FSListVolumes, Tcl_FSEvalFile, Tcl_FSEvalFileEx, Tcl_FSLoadFile, Tcl_FSUnloadFile, Tcl_FSMatchInDirectory, Tcl_FSLink, Tcl_FSLstat, Tcl_FSUtime, Tcl_FSFileAttrsGet, Tcl_FSFileAttrsSet, Tcl_FSFileAttrStrings, Tcl_FSStat, Tcl_FSAccess, Tcl_FSOpenFileChannel, Tcl_FSGetCwd, Tcl_FSChdir, Tcl_FSPathSeparator, Tcl_FSJoinPath, Tcl_FSSplitPath, Tcl_FSEqualPaths, Tcl_FSGetNormalizedPath, Tcl_FSJoinToPath, Tcl_FSConvertToPathType, Tcl_FSGetInternalRep, Tcl_FSGetTranslatedPath, Tcl_FSGetTranslatedStringPath, Tcl_FSNewNativePath, Tcl_FSGetNativePath, Tcl_FSFileSystemInfo, Tcl_GetAccessTimeFromStat, Tcl_GetBlockSizeFromStat, Tcl_GetBlocksFromStat, Tcl_GetChangeTimeFromStat, Tcl_GetDeviceTypeFromStat, Tcl_GetFSDeviceFromStat, Tcl_GetFSInodeFromStat, Tcl_GetGroupIdFromStat, Tcl_GetLinkCountFromStat, Tcl_GetModeFromStat, Tcl_GetModificationTimeFromStat, Tcl_GetSizeFromStat, Tcl_GetUserIdFromStat,…
Tcl_CreateMathFunc, Tcl_GetMathFuncInfo, Tcl_ListMathFuncs – Define, query and enumerate math functions for expressions Synopsis#include <tcl.h> void Tcl_CreateMathFunc(interp, name, numArgs, argTypes, proc, clientData) int Tcl_GetMathFuncInfo(interp, name, numArgsPtr, argTypesPtr, procPtr, clientDataPtr) Tcl_Obj * Tcl_ListMathFuncs(interp, pattern)ArgumentsTcl_Interp *interp (in) Interpreter in which new function will be defined. const char *name (in) Name for new function. int numArgs (in) Number of…
Tcl_IsSafe, Tcl_MakeSafe, Tcl_CreateSlave, Tcl_GetSlave, Tcl_GetMaster, Tcl_GetInterpPath, Tcl_CreateAlias, Tcl_CreateAliasObj, Tcl_GetAlias, Tcl_GetAliasObj, Tcl_ExposeCommand, Tcl_HideCommand – manage multiple Tcl interpreters, aliases and hidden commands Synopsis#include <tcl.h> int Tcl_IsSafe(interp) int Tcl_MakeSafe(interp) Tcl_Interp * Tcl_CreateSlave(interp, slaveName, isSafe) Tcl_Interp * Tcl_GetSlave(interp, slaveName) Tcl_Interp * Tcl_GetMaster(interp) int Tcl_GetInterpPath(askingInterp, slaveInterp) int Tcl_CreateAlias(slaveInterp, slaveCmd, targetInterp, targetCmd, argc, argv) int Tcl_CreateAliasObj(slaveInterp, slaveCmd, targetInterp, targetCmd, objc,…
Tcl_NewIntObj, Tcl_NewLongObj, Tcl_NewWideIntObj, Tcl_SetIntObj, Tcl_SetLongObj, Tcl_SetWideIntObj, Tcl_GetIntFromObj, Tcl_GetLongFromObj, Tcl_GetWideIntFromObj, Tcl_NewBignumObj, Tcl_SetBignumObj, Tcl_GetBignumFromObj, Tcl_TakeBignumFromObj – manipulate Tcl objects as integer values Synopsis#include <tcl.h> Tcl_Obj * Tcl_NewIntObj(intValue) Tcl_Obj * Tcl_NewLongObj(longValue) Tcl_Obj * Tcl_NewWideIntObj(wideValue) Tcl_SetIntObj(objPtr, intValue) Tcl_SetLongObj(objPtr, longValue) Tcl_SetWideIntObj(objPtr, wideValue) int Tcl_GetIntFromObj(interp, objPtr, intPtr) int Tcl_GetLongFromObj(interp, objPtr, longPtr) int Tcl_GetWideIntFromObj(interp, objPtr, widePtr) #include <tclTomMath.h> Tcl_Obj * Tcl_NewBignumObj(bigValue) Tcl_SetBignumObj(objPtr,…
Tcl_FSRegister, Tcl_FSUnregister, Tcl_FSData, Tcl_FSMountsChanged, Tcl_FSGetFileSystemForPath, Tcl_FSGetPathType, Tcl_FSCopyFile, Tcl_FSCopyDirectory, Tcl_FSCreateDirectory, Tcl_FSDeleteFile, Tcl_FSRemoveDirectory, Tcl_FSRenameFile, Tcl_FSListVolumes, Tcl_FSEvalFile, Tcl_FSEvalFileEx, Tcl_FSLoadFile, Tcl_FSUnloadFile, Tcl_FSMatchInDirectory, Tcl_FSLink, Tcl_FSLstat, Tcl_FSUtime, Tcl_FSFileAttrsGet, Tcl_FSFileAttrsSet, Tcl_FSFileAttrStrings, Tcl_FSStat, Tcl_FSAccess, Tcl_FSOpenFileChannel, Tcl_FSGetCwd, Tcl_FSChdir, Tcl_FSPathSeparator, Tcl_FSJoinPath, Tcl_FSSplitPath, Tcl_FSEqualPaths, Tcl_FSGetNormalizedPath, Tcl_FSJoinToPath, Tcl_FSConvertToPathType, Tcl_FSGetInternalRep, Tcl_FSGetTranslatedPath, Tcl_FSGetTranslatedStringPath, Tcl_FSNewNativePath, Tcl_FSGetNativePath, Tcl_FSFileSystemInfo, Tcl_GetAccessTimeFromStat, Tcl_GetBlockSizeFromStat, Tcl_GetBlocksFromStat, Tcl_GetChangeTimeFromStat, Tcl_GetDeviceTypeFromStat, Tcl_GetFSDeviceFromStat, Tcl_GetFSInodeFromStat, Tcl_GetGroupIdFromStat, Tcl_GetLinkCountFromStat, Tcl_GetModeFromStat, Tcl_GetModificationTimeFromStat, Tcl_GetSizeFromStat, Tcl_GetUserIdFromStat,…
Tcl_IsSafe, Tcl_MakeSafe, Tcl_CreateSlave, Tcl_GetSlave, Tcl_GetMaster, Tcl_GetInterpPath, Tcl_CreateAlias, Tcl_CreateAliasObj, Tcl_GetAlias, Tcl_GetAliasObj, Tcl_ExposeCommand, Tcl_HideCommand – manage multiple Tcl interpreters, aliases and hidden commands Synopsis#include <tcl.h> int Tcl_IsSafe(interp) int Tcl_MakeSafe(interp) Tcl_Interp * Tcl_CreateSlave(interp, slaveName, isSafe) Tcl_Interp * Tcl_GetSlave(interp, slaveName) Tcl_Interp * Tcl_GetMaster(interp) int Tcl_GetInterpPath(askingInterp, slaveInterp) int Tcl_CreateAlias(slaveInterp, slaveCmd, targetInterp, targetCmd, argc, argv) int Tcl_CreateAliasObj(slaveInterp, slaveCmd, targetInterp, targetCmd, objc,…
Tcl_NewIntObj, Tcl_NewLongObj, Tcl_NewWideIntObj, Tcl_SetIntObj, Tcl_SetLongObj, Tcl_SetWideIntObj, Tcl_GetIntFromObj, Tcl_GetLongFromObj, Tcl_GetWideIntFromObj, Tcl_NewBignumObj, Tcl_SetBignumObj, Tcl_GetBignumFromObj, Tcl_TakeBignumFromObj – manipulate Tcl objects as integer values Synopsis#include <tcl.h> Tcl_Obj * Tcl_NewIntObj(intValue) Tcl_Obj * Tcl_NewLongObj(longValue) Tcl_Obj * Tcl_NewWideIntObj(wideValue) Tcl_SetIntObj(objPtr, intValue) Tcl_SetLongObj(objPtr, longValue) Tcl_SetWideIntObj(objPtr, wideValue) int Tcl_GetIntFromObj(interp, objPtr, intPtr) int Tcl_GetLongFromObj(interp, objPtr, longPtr) int Tcl_GetWideIntFromObj(interp, objPtr, widePtr) #include <tclTomMath.h> Tcl_Obj * Tcl_NewBignumObj(bigValue) Tcl_SetBignumObj(objPtr,…
Tcl_GetInt, Tcl_GetDouble, Tcl_GetBoolean – convert from string to integer, double, or boolean Synopsis#include <tcl.h> int Tcl_GetInt(interp, src, intPtr) int Tcl_GetDouble(interp, src, doublePtr) int Tcl_GetBoolean(interp, src, boolPtr)ArgumentsTcl_Interp *interp (in) Interpreter to use for error reporting. const char *src (in) Textual value to be converted. int *intPtr (out) Points to place to store integer value converted from…
Tcl_GetIndexFromObj, Tcl_GetIndexFromObjStruct – lookup string in table of keywords Synopsis#include <tcl.h> int Tcl_GetIndexFromObj(interp, objPtr, tablePtr, msg, flags, indexPtr) int Tcl_GetIndexFromObjStruct(interp, objPtr, structTablePtr, offset, msg, flags, indexPtr)ArgumentsTcl_Interp *interp (in) Interpreter to use for error reporting; if NULL, then no message is provided on errors. Tcl_Obj *objPtr (in/out) The string value of this object is used to…