'\"
'\" Copyright (c) 1993 The Regents of the University of California.
'\" Copyright (c) 1994-1997 Sun Microsystems, Inc.
'\"
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\" 
'\" RCS: @(#) $Id: upvar.n,v 1.2 2003/11/24 05:10:00 bbbush Exp $
'\" 
'\" 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 ?version? ?br?
'\"	Begin vertical sidebar, for use in marking newly-changed parts
'\"	of man pages.  The first argument is ignored and used for recording
'\"	the version when the .VS was added, so that the sidebars can be
'\"	found and removed when they reach a certain age.  If another 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.
'\"
'\" RCS: @(#) $Id: upvar.n,v 1.2 2003/11/24 05:10:00 bbbush Exp $
'\"
'\"	# Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
.if t .wh -1.3i ^B
.nr ^l \n(.l
.ad b
'\"	# Start an argument description
.de AP
.ie !"\\$4"" .TP \\$4
.el \{\
.   ie !"\\$2"" .TP \\n()Cu
.   el          .TP 15
.\}
.ta \\n()Au \\n()Bu
.ie !"\\$3"" \{\
\&\\$1	\\fI\\$2\\fP	(\\$3)
.\".b
.\}
.el \{\
.br
.ie !"\\$2"" \{\
\&\\$1	\\fI\\$2\\fP
.\}
.el \{\
\&\\fI\\$1\\fP
.\}
.\}
..
'\"	# define tabbing values for .AP
.de AS
.nr )A 10n
.if !"\\$1"" .nr )A \\w'\\$1'u+3n
.nr )B \\n()Au+15n
.\"
.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
.nr )C \\n()Bu+\\w'(in/out)'u+2n
..
.AS Tcl_Interp Tcl_CreateInterp in/out
'\"	# BS - start boxed text
'\"	# ^y = starting y location
'\"	# ^b = 1
.de BS
.br
.mk ^y
.nr ^b 1u
.if n .nf
.if n .ti 0
.if n \l'\\n(.lu\(ul'
.if n .fi
..
'\"	# BE - end boxed text (draw box now)
.de BE
.nf
.ti 0
.mk ^t
.ie n \l'\\n(^lu\(ul'
.el \{\
.\"	Draw four-sided box normally, but don't draw top of
.\"	box if the box started on an earlier page.
.ie !\\n(^b-1 \{\
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.el \}\
\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.\}
.fi
.br
.nr ^b 0
..
'\"	# VS - start vertical sidebar
'\"	# ^Y = starting y location
'\"	# ^v = 1 (for troff;  for nroff this doesn't matter)
.de VS
.if !"\\$2"" .br
.mk ^Y
.ie n 'mc \s12\(br\s0
.el .nr ^v 1u
..
'\"	# VE - end of vertical sidebar
.de VE
.ie n 'mc
.el \{\
.ev 2
.nf
.ti 0
.mk ^t
\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
.sp -1
.fi
.ev
.\}
.nr ^v 0
..
'\"	# Special macro to handle page bottom:  finish off current
'\"	# box/sidebar if in box/sidebar mode, then invoked standard
'\"	# page bottom macro.
.de ^B
.ev 2
'ti 0
'nf
.mk ^t
.if \\n(^b \{\
.\"	Draw three-sided box if this is the box's first page,
.\"	draw two sides but no top otherwise.
.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.\}
.if \\n(^v \{\
.nr ^x \\n(^tu+1v-\\n(^Yu
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
.\}
.bp
'fi
.ev
.if \\n(^b \{\
.mk ^y
.nr ^b 2
.\}
.if \\n(^v \{\
.mk ^Y
.\}
..
'\"	# DS - begin display
.de DS
.RS
.nf
.sp
..
'\"	# DE - end display
.de DE
.fi
.RE
.sp
..
'\"	# SO - start of list of standard options
.de SO
.SH "STANDARD OPTIONS"
.LP
.nf
.ta 5.5c 11c
.ft B
..
'\"	# SE - end of list of standard options
.de SE
.fi
.ft R
.LP
See the \\fBoptions\\fR manual entry for details on the standard options.
..
'\"	# OP - start of full description for a single option
.de OP
.LP
.nf
.ta 4c
Command-Line Name:	\\fB\\$1\\fR
Database Name:	\\fB\\$2\\fR
Database Class:	\\fB\\$3\\fR
.fi
.IP
..
'\"	# CS - begin code excerpt
.de CS
.RS
.nf
.ta .25i .5i .75i 1i
..
'\"	# CE - end code excerpt
.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH upvar 3tcl "" Tcl "Tcl Built-In Commands"
.BS
'\" Note:  do not modify the .SH NAME line immediately below!
.SH NAME
upvar \- 建立到在不同棧楨上的變數的連線
.SH "總覽 SYNOPSIS"
\fBupvar \fR?\fIlevel\fR? \fIotherVar myVar \fR?\fIotherVar myVar \fR...?
.BE

.SH "描述 DESCRIPTION"
.PP
這個命令安排在當前過程中的一個或多個區域性變數去引用位於包圍它的過程呼叫中的變數或引用全域性變數。 \fILevel\fR 可以用 \fBuplevel\fR 命令允許的任何形式，並且如果第一個 \fIotherVar\fR 的第一個字母不是 \fB#\fR 或一個數字，則可以被省略(它預設為\fB1\fR)。對於每個 \fIotherVar\fR 引數，\fBupvar\fR 使由 \fIlevel\fR 給出的過程楨中(如果 \fIlevel\fR 是 \fB#0 \fR則在全域性層次)的叫這個名字的變數在當前過程中可以用由相應的 \fImyVar\fR 引數給出名字來訪問。在呼叫它的時候叫做 \fIotherVar\fR 的變數不需要存在；可以在第一次引用 \fImyVar\fR 時象普通變數那樣建立它。在呼叫 \fBupvar\fR 的時候一定不能存在一個叫 \fImyVar\fR 的變數。\fIMyVar\fR 總是被作為一個變數的名字來對待，而不是一個數組的元素。即使這個名字看起來象一個數組元素，比如 \fBa(b)\fR，仍建立一個正規的變數。\fIOtherVar\fR 可以引用一個標量變數，或一個數組元素。\fBUpvar\fR 返回一個空串。
.PP
\fBupvar\fR 命令簡化了傳名呼叫(call-by-name)過程的實現並使它易於建立如同 Tcl 過程的新控制結構。例如，考慮下列過程:
.CS
\fBproc add2 name {
	upvar $name x
	set x [expr $x+2]
}\fR
.CE
呼叫\fB Add2\fR 時加上給出一個變數名字的一個引數，它向這個變數的值加二。儘管 \fBadd2\fR 可以使用 \fBuplevel\fR 替代 \fBupvar \fR來實現，\fBupvar\fR 簡便了 \fBadd2\fR 訪問在呼叫者過程楨中的變數。
.PP
\fBnamespace eval\fR 是改變 Tcl 命令上下文的另一種方式(除了過程呼叫之外)。它向棧增加一個呼叫楨來表示名字空間上下文。這意味著每個 \fBnamespace eval\fR 命令被視為給 \fBuplevel\fR 和 \fBupvar\fR 命令的另一個呼叫層次。例如，\fBinfo level 1\fR 將返回描述一個命令的列表，它要麼是最外的過程要麼是最外的 \fBnamespace eval\fR 命令。還有，\fBuplevel #0\fR 在最外面的名字空間(全域性名字空間)中的頂層求值一個指令碼。
.PP
.VS
如果刪除(unset)一個 upvar 變數(比如，上面的 \fBadd2\fR 中的 \fBx\fR )，則 \fBunset\fR 操作影響它所連線到的變數，而不是 upvar 變數。除了退出在其中定義它的那個過程之外，沒有方法刪除一個 upvar 變數。但是，可以透過執行另一個 \fBupvar\fR 命令來為一個 upvar 變數重定目標(retarget)。

.SH "Traces 和 upvar"
.PP
upvar 以一種直接但可能不是預期的方式與 trace 互動。如果在 \fIotherVar \fR上定義了一個變數跟蹤，涉及 \fImyVar \fR的動作將觸發這個追蹤。但是，傳遞給跟蹤過程將是 \fImyVar \fR的名字，而不是 \fIotherVar\fR 的名字。 所以，下列程式碼的輸出將是 \fBlocalVar\fR 而不是 \fBoriginalVar\fR:
.CS
\fBproc traceproc { name index op } {
	puts $name
}
proc setByUpvar { name value } {
	upvar $name localVar
	set localVar $value
}
set originalVar 1
trace variable originalVar w traceproc
setByUpvar originalVar 2
}\fR
.CE

如果 \fIotherVar\fR 引用一個數組的元素，則為整個陣列設定的變數跟蹤在 \fImyVar\fR 被訪問的時候將不被呼叫(但在特定元素上的跟蹤仍將被呼叫)。特別的，如果這個陣列是 \fBenv\fR，則對 \fImyVar\fR 的變動將不被正確的傳遞給子程序。

.VE

.SH "參見 SEE ALSO"
global(n), namespace(n), uplevel(n), variable(n)

.SH "關鍵字 KEYWORDS"
context, frame, global, level, namespace, procedure, variable

.SH "[中文版維護人]"
.B 寒蟬退士
.SH "[中文版最新更新]"
.B 2001/11/21
.SH "《中國 Linux 論壇 man 手冊頁翻譯計劃》:"
.BI http://cmpp.linuxforum.net
.SH "跋"
.br
本頁面中文版由中文 man 手冊頁計劃提供。
.br
中文 man 手冊頁計劃：\fBhttps://github.com/man-pages-zh/manpages-zh\fR