Tcl_CreateMathFunc (3)
Define a new math function for expressions
SYNOPSIS
#include <tcl.h>
Tcl_CreateMathFunc(interp, name, numArgs, argTypes, proc, clientData)
ARGUMENTS
Tcl_ValueType clientData
Tcl_Interp *interp in
Interpreter in which new function will be defined.
char *name in
Name for new function.
int numArgs in
Number of arguments to new function; also gives size of argTypes array.
Tcl_ValueType *argTypes in
Points to an array giving the permissible types for each argument to
function.
Tcl_MathProc *proc in
Procedure that implements the function.
ClientData clientData in
Arbitrary one-word value to pass to proc when it is invoked.
DESCRIPTION
Tcl allows a number of mathematical functions to be used in
expressions, such as sin, cos, and hypot.
Tcl_CreateMathFunc allows applications to add additional functions
to those already provided by Tcl or to replace existing functions.
Name is the name of the function as it will appear in expressions.
If name doesn't already exist as a function then a new function
is created. If it does exist, then the existing function is replaced.
NumArgs and argTypes describe the arguments to the function.
Each entry in the argTypes array must be either TCL_INT, TCL_DOUBLE,
or TCL_EITHER to indicate whether the corresponding argument must be an
integer, a double-precision floating value, or either, respectively.
Whenever the function is invoked in an expression Tcl will invoke
proc. Proc should have arguments and result that match
the type Tcl_MathProc:
typedef int Tcl_MathProc(
ClientData clientData,
Tcl_Interp *interp,
Tcl_Value *args,
Tcl_Value *resultPtr);
When proc is invoked the clientData and interp
arguments will be the same as those passed to Tcl_CreateMathFunc.
Args will point to an array of numArgs Tcl_Value structures,
which describe the actual arguments to the function:
typedef struct Tcl_Value {
Tcl_ValueType type;
long intValue;
double doubleValue;
} Tcl_Value;
The type field indicates the type of the argument and is
either TCL_INT or TCL_DOUBLE.
It will match the argTypes value specified for the function unless
the argTypes value was TCL_EITHER. Tcl converts
the argument supplied in the expression to the type requested in
argTypes, if that is necessary.
Depending on the value of the type field, the intValue
or doubleValue field will contain the actual value of the argument.
Proc should compute its result and store it either as an integer
in resultPtr->intValue or as a floating value in
resultPtr->doubleValue.
It should set also resultPtr->type to either TCL_INT or TCL_DOUBLE
to indicate which value was set.
Under normal circumstances proc should return TCL_OK.
If an error occurs while executing the function, proc should
return TCL_ERROR and leave an error message in interp->result.
KEYWORDS
expression, mathematical function
'\"
'\" Copyright (c) 1995-1996 Sun Microsystems, Inc.
'\"
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
'\" SCCS: @(#) CrtModalTmt.3 1.3 96/03/25 20:00:19
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\" Start paragraph describing an argument to a library procedure.
'\" type is type of argument (int, etc.), in/out is either "in", "out",
'\" or "in/out" to describe whether procedure reads or modifies arg,
'\" and indent is equivalent to second arg of .IP (shouldn't ever be
'\" needed; use .AS below instead)
'\"
'\" .AS ?type? ?name?
'\" Give maximum sizes of arguments for setting tab stops. Type and
'\" name are examples of largest possible arguments that will be passed
'\" to .AP later. If args are omitted, default tab stops are used.
'\"
'\" .BS
'\" Start box enclosure. From here until next .BE, everything will be
'\" enclosed in one large box.
'\"
'\" .BE
'\" End of box enclosure.
'\"
'\" .CS
'\" Begin code excerpt.
'\"
'\" .CE
'\" End code excerpt.
'\"
'\" .VS ?br?
'\" Begin vertical sidebar, for use in marking newly-changed parts
'\" of man pages. If an argument is present, then a line break is
'\" forced before starting the sidebar.
'\"
'\" .VE
'\" End of vertical sidebar.
'\"
'\" .DS
'\" Begin an indented unfilled display.
'\"
'\" .DE
'\" End of indented unfilled display.
'\"
'\" .SO
'\" Start of list of standard options for a Tk widget. The
'\" options follow on successive lines, in four columns separated
'\" by tabs.
'\"
'\" .SE
'\" End of list of standard options for a Tk widget.
'\"
'\" .OP cmdName dbName dbClass
'\" Start of description of a specific option. cmdName gives the
'\" option's name as specified in the class command, dbName gives
'\" the option's name in the option database, and dbClass gives
'\" the option's class in the option database.
'\"
'\" .UL arg1 arg2
'\" Print arg1 underlined, then print arg2 normally.
'\"
'\" SCCS: @(#) man.macros 1.8 96/02/15 20:02:24
'\"
'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
t .wh -1.3i ^B
^l \n(.l
b
'\" # Start an argument description
AP
!"\\$4"" .TP \\$4
\{\
!"\\$2"" .TP \\n()Cu
.TP 15
|
