Tcl Library Manual

Tcl_AddErrorInfo

Tcl_SetErrorCode

Tcl_PosixError

record information about errors

• NAME
• SYNOPSIS
  #include <tcl.h>
  Tcl_AddErrorInfo(interp, message)
  Tcl_SetErrorCode(interp, element, element, ... (char *) NULL)
  char *
  Tcl_PosixError(interp)
  
• ARGUMENTS
• DESCRIPTION
• SEE ALSO
• KEYWORDS

Tcl_AllowExceptions

allow all exceptions in next script evaluation

• NAME
• SYNOPSIS
  #include <tcl.h>
  Tcl_AllowExceptions(interp)
  
• ARGUMENTS
• DESCRIPTION
• KEYWORDS

Tcl_AppInit

Perform application-specific initialization

• NAME
• SYNOPSIS
  #include <tcl.h>
  Tcl_AppInit(interp)
  
• ARGUMENTS
• DESCRIPTION
• KEYWORDS

Tcl_SetResult

Tcl_AppendResult

Tcl_AppendElement

Tcl_ResetResult

manipulate Tcl result string

• NAME
• SYNOPSIS
  #include <tcl.h>
  Tcl_SetResult(interp, string, freeProc)
  Tcl_AppendResult(interp, string, string, ... , (char *) NULL)
  Tcl_AppendElement(interp, string)
  Tcl_ResetResult(interp)
  Tcl_FreeResult(interp)
  
• ARGUMENTS
• DESCRIPTION
• SEE ALSO
• KEYWORDS

Tcl_AsyncCreate

Tcl_AsyncMark

Tcl_AsyncInvoke

Tcl_AsyncDelete

handle asynchronous events

• NAME
• SYNOPSIS
  #include <tcl.h>
  extern int tcl_AsyncReady;
  Tcl_AsyncHandler
  Tcl_AsyncCreate(proc, clientData)
  Tcl_AsyncMark(async)
  int
  Tcl_AsyncInvoke(interp, code)
  Tcl_AsyncDelete(async)
  
• ARGUMENTS
• DESCRIPTION
• WARNING
• KEYWORDS

Tcl_Backslash

parse a backslash sequence

• NAME
• SYNOPSIS
  #include <tcl.h>
  char
  Tcl_Backslash(src, countPtr)
  
• ARGUMENTS
• DESCRIPTION
• KEYWORDS

Tcl_CallWhenDeleted

Tcl_DontCallWhenDeleted

Arrange for callback when interpreter is deleted

• NAME
• SYNOPSIS
  #include <tcl.h>
  Tcl_CallWhenDeleted(interp, proc, clientData)
  Tcl_DontCallWhenDeleted(interp, proc, clientData)
  
• ARGUMENTS
• DESCRIPTION
• KEYWORDS

Tcl_CommandComplete

Check for unmatched braces in a Tcl command

• NAME
• SYNOPSIS
  #include <tcl.h>
  int
  Tcl_CommandComplete(cmd)
  
• ARGUMENTS
• DESCRIPTION
• KEYWORDS

Tcl_Concat

concatenate a collection of strings

• NAME
• SYNOPSIS
  #include <tcl.h>
  char *
  Tcl_Concat(argc, argv)
  
• ARGUMENTS
• DESCRIPTION
• KEYWORDS

Tcl_SplitList

Tcl_Merge

Tcl_ScanElement

Tcl_ConvertElement

manipulate Tcl lists

• NAME
• SYNOPSIS
  #include <tcl.h>
  int
  Tcl_SplitList(interp, list, argcPtr, argvPtr)
  char *
  Tcl_Merge(argc, argv)
  int
  Tcl_ScanElement(src, flagsPtr)
  int
  Tcl_ConvertElement(src, dst, flags)
  
• ARGUMENTS
• DESCRIPTION
• KEYWORDS

Tcl_CreateCommand

Tcl_DeleteCommand

Tcl_GetCommandInfo

Tcl_SetCommandInfo

implement new commands in C

• NAME
• SYNOPSIS
  #include <tcl.h>
  Tcl_Command
  Tcl_CreateCommand(interp, cmdName, proc, clientData, deleteProc)
  int
  Tcl_DeleteCommand(interp, cmdName)
  int
  Tcl_GetCommandInfo(interp, cmdName, infoPtr)
  int
  Tcl_SetCommandInfo(interp, cmdName, infoPtr)
  char *
  Tcl_GetCommandName(interp, token)
  
• ARGUMENTS
• DESCRIPTION
• KEYWORDS

Tcl_InitHashTable

Tcl_DeleteHashTable

Tcl_CreateHashEntry

Tcl_DeleteHashEntry

Tcl_FindHashEntry

Tcl_GetHashValue

Tcl_SetHashValue

Tcl_GetHashKey

Tcl_FirstHashEntry

Tcl_NextHashEntry

Tcl_HashStats

procedures to manage hash tables

• NAME
• SYNOPSIS
  #include <tcl.h>
  Tcl_InitHashTable(tablePtr, keyType)
  Tcl_DeleteHashTable(tablePtr)
  Tcl_HashEntry *
  Tcl_CreateHashEntry(tablePtr, key, newPtr)
  Tcl_DeleteHashEntry(entryPtr)
  Tcl_HashEntry *
  Tcl_FindHashEntry(tablePtr, key)
  ClientData
  Tcl_GetHashValue(entryPtr)
  Tcl_SetHashValue(entryPtr, value)
  char *
  Tcl_GetHashKey(tablePtr, entryPtr)
  Tcl_HashEntry *
  Tcl_FirstHashEntry(tablePtr, searchPtr)
  Tcl_HashEntry *
  Tcl_NextHashEntry(searchPtr)
  char *
  Tcl_HashStats(tablePtr)
  
• ARGUMENTS
• DESCRIPTION
  • TCL_STRING_KEYS
  • TCL_ONE_WORD_KEYS
  • other
• KEYWORDS

Tcl_CreateInterp

Tcl_DeleteInterp

create and delete Tcl command interpreters

• NAME
• SYNOPSIS
  #include <tcl.h>
  Tcl_Interp *
  Tcl_CreateInterp()
  Tcl_DeleteInterp(interp)
  
• ARGUMENTS
• DESCRIPTION
• KEYWORDS

Tcl_CreateMathFunc

Define a new math function for expressions

• NAME
• SYNOPSIS
  #include <tcl.h>
  Tcl_CreateMathFunc(interp, name, numArgs, argTypes, proc, clientData)
  
• ARGUMENTS
• DESCRIPTION
• KEYWORDS

Tcl_CreatePipeline

create one or more child processes, with I/O redirection

• NAME
• SYNOPSIS
  #include <tcl.h>
  int
  Tcl_CreatePipeline(interp, argc, argv, pidArrayPtr, inPipePtr, outPipePtr, errFilePtr)
  
• ARGUMENTS
• DESCRIPTION
• SEE ALSO
• KEYWORDS

Tcl_CreateTrace

Tcl_DeleteTrace

arrange for command execution to be traced

• NAME
• SYNOPSIS
  #include <tcl.h>
  Tcl_Trace
  Tcl_CreateTrace(interp, level, proc, clientData)
  Tcl_DeleteTrace(interp, trace)
  
• ARGUMENTS
• DESCRIPTION
• KEYWORDS

Tcl_DStringInit

Tcl_DStringAppend

Tcl_DStringAppendElement

Tcl_DStringStartSublist

Tcl_DStringEndSublist

Tcl_DStringLength

Tcl_DStringValue

Tcl_DStringSetLength

Tcl_DStringFree

Tcl_DStringResult

Tcl_DStringGetResult

manipulate dynamic strings

• NAME
• SYNOPSIS
  #include <tcl.h>
  Tcl_DStringInit(dsPtr)
  char *
  Tcl_DStringAppend(dsPtr, string, length)
  char *
  Tcl_DStringAppendElement(dsPtr, string)
  Tcl_DStringStartSublist(dsPtr)
  Tcl_DStringEndSublist(dsPtr)
  int
  Tcl_DStringLength(dsPtr)
  char *
  Tcl_DStringValue(dsPtr)
  Tcl_DStringSetLength(dsPtr, newLength)
  Tcl_DStringFree(dsPtr)
  Tcl_DStringResult(interp, dsPtr)
  Tcl_DStringGetResult(interp, dsPtr)
  
• ARGUMENTS
• DESCRIPTION
• KEYWORDS

Tcl_DetachPids

Tcl_ReapDetachedProcs

manage child processes in background

• NAME
• SYNOPSIS
  #include <tcl.h>
  Tcl_DetachPids(numPids, pidPtr)
  Tcl_ReapDetachedProcs()
  
• ARGUMENTS
• DESCRIPTION
• KEYWORDS

Tcl_EnterFile

Tcl_GetOpenFile

Tcl_FilePermissions

manipulate the table of open files

• NAME
• SYNOPSIS
  #include <tcl.h>
  Tcl_EnterFile(interp, file, permissions)
  int
  Tcl_GetOpenFile(interp, string, write, checkUsage, filePtr)
  int
  Tcl_FilePermissions(file)
  
• ARGUMENTS
• DESCRIPTION
• KEYWORDS

Tcl_Eval

Tcl_VarEval

Tcl_EvalFile

Tcl_GlobalEval

execute Tcl commands

• NAME
• SYNOPSIS
  #include <tcl.h>
  int
  Tcl_Eval(interp, cmd)
  int
  Tcl_VarEval(interp, string, string, ... (char *) NULL)
  int
  Tcl_EvalFile(interp, fileName)
  int
  Tcl_GlobalEval(interp, cmd)
  
• ARGUMENTS
• DESCRIPTION
• KEYWORDS

Tcl_ExprLong

Tcl_ExprDouble

Tcl_ExprBoolean

Tcl_ExprString

evaluate an expression

• NAME
• SYNOPSIS
  #include <tcl.h>
  int
  Tcl_ExprLong(interp, string, longPtr)
  int
  Tcl_ExprDouble(interp, string, doublePtr)
  int
  Tcl_ExprBoolean(interp, string, booleanPtr)
  int
  Tcl_ExprString(interp, string)
  
• ARGUMENTS
• DESCRIPTION
• KEYWORDS

Tcl_GetInt

Tcl_GetDouble

Tcl_GetBoolean

convert from string to integer, double, or boolean

• NAME
• SYNOPSIS
  #include <tcl.h>
  int
  Tcl_GetInt(interp, string, intPtr)
  int
  Tcl_GetDouble(interp, string, doublePtr)
  int
  Tcl_GetBoolean(interp, string, boolPtr)
  
• ARGUMENTS
• DESCRIPTION
• KEYWORDS

Tcl_SetVar

Tcl_SetVar2

Tcl_GetVar

Tcl_GetVar2

Tcl_UnsetVar

Tcl_UnsetVar2

manipulate Tcl variables

• NAME
• SYNOPSIS
  #include <tcl.h>
  char *
  Tcl_SetVar(interp, varName, newValue, flags)
  char *
  Tcl_SetVar2(interp, name1, name2, newValue, flags)
  char *
  Tcl_GetVar(interp, varName, flags)
  char *
  Tcl_GetVar2(interp, name1, name2, flags)
  int
  Tcl_UnsetVar(interp, varName, flags)
  int
  Tcl_UnsetVar2(interp, name1, name2, flags)
  
• ARGUMENTS
• DESCRIPTION
  • TCL_GLOBAL_ONLY
  • TCL_LEAVE_ERR_MSG
  • TCL_APPEND_VALUE
  • TCL_LIST_ELEMENT
• SEE ALSO
• KEYWORDS

Tcl_Interp

client-visible fields of interpreter structures

• NAME
• SYNOPSIS
  #include <tcl.h>
  typedef struct {
  char *result;
  Tcl_FreeProc *freeProc;
  int errorLine;
  } Tcl_Interp;
  
  typedef void Tcl_FreeProc(char *blockPtr);
  
• DESCRIPTION
• KEYWORDS

Tcl_LinkVar

Tcl_UnlinkVar

link Tcl variable to C variable

• NAME
• SYNOPSIS
  #include <tcl.h>
  int
  Tcl_LinkVar(interp, varName, addr, type)
  Tcl_UnlinkVar(interp, varName)
  
• ARGUMENTS
• DESCRIPTION
  • TCL_LINK_INT
  • TCL_LINK_DOUBLE
  • TCL_LINK_BOOLEAN
  • TCL_LINK_STRING
• KEYWORDS

Tcl_Main

main program for Tcl-based applications

• NAME
• SYNOPSIS
  #include <tk.h>
  Tcl_Main(argc, argv)
  
• ARGUMENTS
• DESCRIPTION
• KEYWORDS

Tcl_PrintDouble

Convert floating value to string

• NAME
• SYNOPSIS
  #include <tcl.h>
  Tcl_PrintDouble(interp, value, dst)
  
• ARGUMENTS
• DESCRIPTION
• KEYWORDS

Tcl_RecordAndEval

save command on history list before evaluating

• NAME
• SYNOPSIS
  #include <tcl.h>
  int
  Tcl_RecordAndEval(interp, cmd, eval)
  
• ARGUMENTS
• DESCRIPTION
• KEYWORDS

Tcl_RegExpMatch

Tcl_RegExpCompile

Tcl_RegExpExec

Tcl_RegExpRange

Pattern matching with regular expressions

• NAME
• SYNOPSIS
  #include <tcl.h>
  int
  Tcl_RegExpMatch(interp, string, pattern)
  Tcl_RegExp
  Tcl_RegExpCompile(interp, pattern)
  int
  Tcl_RegExpExec(interp, regexp, string, start)
  Tcl_RegExpRange(interp, index, startPtr, endPtr)
  
• ARGUMENTS
• DESCRIPTION
• KEYWORDS

Tcl_SetRecursionLimit

set maximum allowable nesting depth in interpreter

• NAME
• SYNOPSIS
  #include <tcl.h>
  int
  Tcl_SetRecursionLimit(interp, depth)
  
• ARGUMENTS
• DESCRIPTION
• KEYWORDS

Tcl_StringMatch

test whether a string matches a pattern

• NAME
• SYNOPSIS
  #include <tcl.h>
  int
  Tcl_StringMatch(string, pattern)
  
• ARGUMENTS
• DESCRIPTION
• KEYWORDS

Tcl_TildeSubst

replace tilde with home directory in a file name

• NAME
• SYNOPSIS
  #include <tcl.h>
  char *
  Tcl_TildeSubst(interp, name, bufferPtr)
  
• ARGUMENTS
• DESCRIPTION
• KEYWORDS

Tcl_TraceVar

Tcl_TraceVar2

Tcl_UntraceVar

Tcl_UntraceVar2

Tcl_VarTraceInfo

Tcl_VarTraceInfo2

monitor accesses to a variable

• NAME
• SYNOPSIS
  #include <tcl.h>
  int
  Tcl_TraceVar(interp, varName, flags, proc, clientData)
  int
  Tcl_TraceVar2(interp, name1, name2, flags, proc, clientData)
  Tcl_UntraceVar(interp, varName, flags, proc, clientData)
  Tcl_UntraceVar2(interp, name1, name2, flags, proc, clientData)
  ClientData
  Tcl_VarTraceInfo(interp, varName, flags, proc, prevClientData)
  ClientData
  Tcl_VarTraceInfo2(interp, name1, name2, flags, proc, prevClientData)
  
• ARGUMENTS
• DESCRIPTION
  • TCL_GLOBAL_ONLY
  • TCL_TRACE_READS
  • TCL_TRACE_WRITES
  • TCL_TRACE_UNSETS
• TWO-PART NAMES
• ACCESSING VARIABLES DURING TRACES
• CALLBACK TIMING
• WHOLE-ARRAY TRACES
• MULTIPLE TRACES
• ERROR RETURNS
• RESTRICTIONS
• UNDEFINED VARIABLES
• TCL_TRACE_DELETED FLAG
• TCL_INTERP_DESTROYED
• BUGS
• KEYWORDS

Tcl_UpVar

Tcl_UpVar2

link one variable to another

• NAME
• SYNOPSIS
  #include <tcl.h>
  int
  Tcl_UpVar(interp, frameName, sourceName, destName, flags)
  int
  Tcl_UpVar2(interp, frameName, name1, name2, destName, flags)
  
• ARGUMENTS
• DESCRIPTION
• KEYWORDS

Copyright © 1989-1994 The Regents of the University of California.
Copyright © 1994-1995 Sun Microsystems, Inc.
Copyright © 1995 Roger E. Critchlow Jr.