SubstObj.3
上传用户:rrhhcc
上传日期:2015-12-11
资源大小:54129k
文件大小:3k
- '"
- '" Copyright (c) 2001 Donal K. Fellows
- '"
- '" See the file "license.terms" for information on usage and redistribution
- '" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
- '"
- '" RCS: @(#) $Id: SubstObj.3,v 1.1 2001/07/12 13:15:09 dkf Exp $
- '"
- .so man.macros
- .TH Tcl_SubstObj 3 8.4 Tcl "Tcl Library Procedures"
- .BS
- .SH NAME
- Tcl_SubstObj - perform substitutions on Tcl objects
- .SH SYNOPSIS
- .nf
- fB#include <tcl.h>fR
- .sp
- Tcl_Obj *
- fBTcl_SubstObjfR(fIinterp, objPtr, flagsfR)
- .SH ARGUMENTS
- .AS Tcl_Interp **termPtr;
- .AP Tcl_Interp *interp in
- Interpreter in which to execute Tcl scripts and lookup variables. If
- an error occurs, the interpreter's result is modified to hold an error
- message.
- .AP Tcl_Obj *objPtr in
- A Tcl object containing the string to perform substitutions on.
- .AP int flags in
- ORed combination of flag bits that specify which substitutions to
- perform. The flags fBTCL_SUBST_COMMANDSfR,
- fBTCL_SUBST_VARIABLESfR and fBTCL_SUBST_BACKSLASHESfR are
- currently supported, and fBTCL_SUBST_ALLfR is provided as a
- convenience for the common case where all substitutions are desired.
- .BE
- .SH DESCRIPTION
- .PP
- The fBTcl_SubstObjfR function is used to perform substitutions on
- strings in the fashion of the fBsubstfR command. It gets the value
- of the string contained in fIobjPtrfR and scans it, copying
- characters and performing the chosen substitutions as it goes to an
- output object which is returned as the result of the function. In the
- event of an error occurring during the execution of a command or
- variable substitution, the function returns NULL and an error message
- is left in fIinterpfR's result.
- .PP
- Three kinds of substitutions are supported. When the
- fBTCL_SUBST_BACKSLASHESfR bit is set in fIflagsfR, sequences that
- look like backslash substitutions for Tcl commands are replaced by
- their corresponding character.
- .PP
- When the fBTCL_SUBST_VARIABLESfR bit is set in fIflagsfR,
- sequences that look like variable substitutions for Tcl commands are
- replaced by the contents of the named variable.
- .PP
- When th fBTCL_SUBST_COMMANDSfR bit is set in fIflagsfR, sequences
- that look like command substitutions for Tcl commands are replaced by
- the result of evaluating that script. Where an uncaught continue
- exception occurs during the evaluation of a command substitution, an
- empty string is substituted for the command. Where an uncaught break
- exception occurs during the evaluation of a command substitution, the
- result of the whole substitution on fIobjPtrfR will be truncated at
- the point immediately before the start of the command substitution,
- and no characters will be added to the result or substitutions
- performed after that point.
- .SH "SEE ALSO"
- subst(n)
- .SH KEYWORDS
- backslash substitution, command substitution, variable substitution