SubstObj.3
上传用户:rrhhcc
上传日期:2015-12-11
资源大小:54129k
文件大小:3k
源码类别:

通讯编程

开发平台:

Visual C++

  1. '"
  2. '" Copyright (c) 2001 Donal K. Fellows
  3. '"
  4. '" See the file "license.terms" for information on usage and redistribution
  5. '" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
  6. '" 
  7. '" RCS: @(#) $Id: SubstObj.3,v 1.1 2001/07/12 13:15:09 dkf Exp $
  8. '" 
  9. .so man.macros
  10. .TH Tcl_SubstObj 3 8.4 Tcl "Tcl Library Procedures"
  11. .BS
  12. .SH NAME
  13. Tcl_SubstObj - perform substitutions on Tcl objects
  14. .SH SYNOPSIS
  15. .nf
  16. fB#include <tcl.h>fR
  17. .sp
  18. Tcl_Obj *
  19. fBTcl_SubstObjfR(fIinterp, objPtr, flagsfR)
  20. .SH ARGUMENTS
  21. .AS Tcl_Interp **termPtr;
  22. .AP Tcl_Interp *interp in
  23. Interpreter in which to execute Tcl scripts and lookup variables.  If
  24. an error occurs, the interpreter's result is modified to hold an error
  25. message.
  26. .AP Tcl_Obj *objPtr in
  27. A Tcl object containing the string to perform substitutions on.
  28. .AP int flags in
  29. ORed combination of flag bits that specify which substitutions to
  30. perform.  The flags fBTCL_SUBST_COMMANDSfR,
  31. fBTCL_SUBST_VARIABLESfR and fBTCL_SUBST_BACKSLASHESfR are
  32. currently supported, and fBTCL_SUBST_ALLfR is provided as a
  33. convenience for the common case where all substitutions are desired.
  34. .BE
  35. .SH DESCRIPTION
  36. .PP
  37. The fBTcl_SubstObjfR function is used to perform substitutions on
  38. strings in the fashion of the fBsubstfR command.  It gets the value
  39. of the string contained in fIobjPtrfR and scans it, copying
  40. characters and performing the chosen substitutions as it goes to an
  41. output object which is returned as the result of the function.  In the
  42. event of an error occurring during the execution of a command or
  43. variable substitution, the function returns NULL and an error message
  44. is left in fIinterpfR's result.
  45. .PP
  46. Three kinds of substitutions are supported.  When the
  47. fBTCL_SUBST_BACKSLASHESfR bit is set in fIflagsfR, sequences that
  48. look like backslash substitutions for Tcl commands are replaced by
  49. their corresponding character.
  50. .PP
  51. When the fBTCL_SUBST_VARIABLESfR bit is set in fIflagsfR,
  52. sequences that look like variable substitutions for Tcl commands are
  53. replaced by the contents of the named variable.
  54. .PP
  55. When th fBTCL_SUBST_COMMANDSfR bit is set in fIflagsfR, sequences
  56. that look like command substitutions for Tcl commands are replaced by
  57. the result of evaluating that script.  Where an uncaught continue
  58. exception occurs during the evaluation of a command substitution, an
  59. empty string is substituted for the command.  Where an uncaught break
  60. exception occurs during the evaluation of a command substitution, the
  61. result of the whole substitution on fIobjPtrfR will be truncated at
  62. the point immediately before the start of the command substitution,
  63. and no characters will be added to the result or substitutions
  64. performed after that point.
  65. .SH "SEE ALSO"
  66. subst(n)
  67. .SH KEYWORDS
  68. backslash substitution, command substitution, variable substitution