[OpenSPARC-T2-SAM] / sam-t2 / devtools / v8plus / man / man3 / Tcl_BackgroundError.3

'\"
'\" Copyright (c) 1992-1994 The Regents of the University of California.
'\" Copyright (c) 1994-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.
'\" 
'\" RCS: @(#) $Id: BackgdErr.3,v 1.3 2000/04/14 23:01:48 hobbs 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: man.macros,v 1.4 2000/08/25 06:18:32 ericm 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 Tcl_BackgroundError 3 7.5 Tcl "Tcl Library Procedures"
.BS
.SH NAME
Tcl_BackgroundError \- report Tcl error that occurred in background processing
.SH SYNOPSIS
.nf
\fB#include <tcl.h>\fR
.sp
\fBTcl_BackgroundError\fR(\fIinterp\fR)
.SH ARGUMENTS
.AS Tcl_Interp *interp
.AP Tcl_Interp *interp in
Interpreter in which the error occurred.
.BE

.SH DESCRIPTION
.PP
This procedure is typically invoked when a Tcl error occurs during
``background processing'' such as executing an event handler.
When such an error occurs, the error condition is reported to Tcl
or to a widget or some other C code, and there is not usually any
obvious way for that code to report the error to the user.
In these cases the code calls \fBTcl_BackgroundError\fR with an
\fIinterp\fR argument identifying the interpreter in which the
error occurred.  At the time \fBTcl_BackgroundError\fR is invoked,
the interpreter's result is expected to contain an error message.
\fBTcl_BackgroundError\fR will invoke the \fBbgerror\fR
Tcl command to report the error in an application-specific fashion.
If no \fBbgerror\fR command exists, or if it returns with an error condition,
then \fBTcl_BackgroundError\fR reports the error itself by printing
a message on the standard error file.
.PP
\fBTcl_BackgroundError\fR does not invoke \fBbgerror\fR immediately
because this could potentially interfere with scripts that are in process
at the time the error occurred.
Instead, it invokes \fBbgerror\fR later as an idle callback.
\fBTcl_BackgroundError\fR saves the values of the \fBerrorInfo\fR and
\fBerrorCode\fR variables and restores these values just before
invoking \fBbgerror\fR.
.PP
It is possible for many background errors to accumulate before
\fBbgerror\fR is invoked.  When this happens, each of the errors
is processed in order.  However, if \fBbgerror\fR returns a
break exception, then all remaining error reports for the
interpreter are skipped.

.SH KEYWORDS
background, bgerror, error
Commit	Line	Data
920dae64 AT	1	'\"
	2	'\" Copyright (c) 1992-1994 The Regents of the University of California.
	3	'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
	4	'\"
	5	'\" See the file "license.terms" for information on usage and redistribution
	6	'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
	7	'\"
	8	'\" RCS: @(#) $Id: BackgdErr.3,v 1.3 2000/04/14 23:01:48 hobbs Exp $
	9	'\"
	10	'\" The definitions below are for supplemental macros used in Tcl/Tk
	11	'\" manual entries.
	12	'\"
	13	'\" .AP type name in/out ?indent?
	14	'\" Start paragraph describing an argument to a library procedure.
	15	'\" type is type of argument (int, etc.), in/out is either "in", "out",
	16	'\" or "in/out" to describe whether procedure reads or modifies arg,
	17	'\" and indent is equivalent to second arg of .IP (shouldn't ever be
	18	'\" needed; use .AS below instead)
	19	'\"
	20	'\" .AS ?type? ?name?
	21	'\" Give maximum sizes of arguments for setting tab stops. Type and
	22	'\" name are examples of largest possible arguments that will be passed
	23	'\" to .AP later. If args are omitted, default tab stops are used.
	24	'\"
	25	'\" .BS
	26	'\" Start box enclosure. From here until next .BE, everything will be
	27	'\" enclosed in one large box.
	28	'\"
	29	'\" .BE
	30	'\" End of box enclosure.
	31	'\"
	32	'\" .CS
	33	'\" Begin code excerpt.
	34	'\"
	35	'\" .CE
	36	'\" End code excerpt.
	37	'\"
	38	'\" .VS ?version? ?br?
	39	'\" Begin vertical sidebar, for use in marking newly-changed parts
	40	'\" of man pages. The first argument is ignored and used for recording
	41	'\" the version when the .VS was added, so that the sidebars can be
	42	'\" found and removed when they reach a certain age. If another argument
	43	'\" is present, then a line break is forced before starting the sidebar.
	44	'\"
	45	'\" .VE
	46	'\" End of vertical sidebar.
	47	'\"
	48	'\" .DS
	49	'\" Begin an indented unfilled display.
	50	'\"
	51	'\" .DE
	52	'\" End of indented unfilled display.
	53	'\"
	54	'\" .SO
	55	'\" Start of list of standard options for a Tk widget. The
	56	'\" options follow on successive lines, in four columns separated
	57	'\" by tabs.
	58	'\"
	59	'\" .SE
	60	'\" End of list of standard options for a Tk widget.
	61	'\"
	62	'\" .OP cmdName dbName dbClass
	63	'\" Start of description of a specific option. cmdName gives the
	64	'\" option's name as specified in the class command, dbName gives
65	'\" the option's name in the option database, and dbClass gives
66	'\" the option's class in the option database.
67	'\"
68	'\" .UL arg1 arg2
69	'\" Print arg1 underlined, then print arg2 normally.
70	'\"
71	'\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
72	'\"
73	'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
74	.if t .wh -1.3i ^B
75	.nr ^l \n(.l
76	.ad b
77	'\" # Start an argument description
78	.de AP
79	.ie !"\\$4"" .TP \\$4
80	.el \{\
81	. ie !"\\$2"" .TP \\n()Cu
82	. el .TP 15
83	.\}
84	.ta \\n()Au \\n()Bu
85	.ie !"\\$3"" \{\
86	\&\\$1 \\fI\\$2\\fP (\\$3)
87	.\".b
88	.\}
89	.el \{\
90	.br
91	.ie !"\\$2"" \{\
92	\&\\$1 \\fI\\$2\\fP
93	.\}
94	.el \{\
95	\&\\fI\\$1\\fP
96	.\}
97	.\}
98	..
99	'\" # define tabbing values for .AP
100	.de AS
101	.nr )A 10n
102	.if !"\\$1"" .nr )A \\w'\\$1'u+3n
103	.nr )B \\n()Au+15n
104	.\"
105	.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
106	.nr )C \\n()Bu+\\w'(in/out)'u+2n
107	..
108	.AS Tcl_Interp Tcl_CreateInterp in/out
109	'\" # BS - start boxed text
110	'\" # ^y = starting y location
111	'\" # ^b = 1
112	.de BS
113	.br
114	.mk ^y
115	.nr ^b 1u
116	.if n .nf
117	.if n .ti 0
118	.if n \l'\\n(.lu\(ul'
119	.if n .fi
120	..
121	'\" # BE - end boxed text (draw box now)
122	.de BE
123	.nf
124	.ti 0
125	.mk ^t
126	.ie n \l'\\n(^lu\(ul'
127	.el \{\
128	.\" Draw four-sided box normally, but don't draw top of
129	.\" box if the box started on an earlier page.
130	.ie !\\n(^b-1 \{\
131	\h'-1.5n'\L'\|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'\|0u-1.5n\(ul'
132	.\}
133	.el \}\
134	\h'-1.5n'\L'\|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'\|0u-1.5n\(ul'
135	.\}
136	.\}
137	.fi
138	.br
139	.nr ^b 0
140	..
141	'\" # VS - start vertical sidebar
142	'\" # ^Y = starting y location
143	'\" # ^v = 1 (for troff; for nroff this doesn't matter)
144	.de VS
145	.if !"\\$2"" .br
146	.mk ^Y
147	.ie n 'mc \s12\(br\s0
148	.el .nr ^v 1u
149	..
150	'\" # VE - end of vertical sidebar
151	.de VE
152	.ie n 'mc
153	.el \{\
154	.ev 2
155	.nf
156	.ti 0
157	.mk ^t
158	\h'\|\\n(^lu+3n'\L'\|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-\|\\n(^lu+3n'
159	.sp -1
160	.fi
161	.ev
162	.\}
163	.nr ^v 0
164	..
165	'\" # Special macro to handle page bottom: finish off current
166	'\" # box/sidebar if in box/sidebar mode, then invoked standard
167	'\" # page bottom macro.
168	.de ^B
169	.ev 2
170	'ti 0
171	'nf
172	.mk ^t
173	.if \\n(^b \{\
174	.\" Draw three-sided box if this is the box's first page,
175	.\" draw two sides but no top otherwise.
176	.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
177	.el \h'-1.5n'\L'\|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'\|0u'\c
178	.\}
179	.if \\n(^v \{\
180	.nr ^x \\n(^tu+1v-\\n(^Yu
181	\kx\h'-\\nxu'\h'\|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'\|0u'\c
182	.\}
183	.bp
184	'fi
185	.ev
186	.if \\n(^b \{\
187	.mk ^y
188	.nr ^b 2
189	.\}
190	.if \\n(^v \{\
191	.mk ^Y
192	.\}
193	..
194	'\" # DS - begin display
195	.de DS
196	.RS
197	.nf
198	.sp
199	..
200	'\" # DE - end display
201	.de DE
202	.fi
203	.RE
204	.sp
205	..
206	'\" # SO - start of list of standard options
207	.de SO
208	.SH "STANDARD OPTIONS"
209	.LP
210	.nf
211	.ta 5.5c 11c
212	.ft B
213	..
214	'\" # SE - end of list of standard options
215	.de SE
216	.fi
217	.ft R
218	.LP
219	See the \\fBoptions\\fR manual entry for details on the standard options.
220	..
221	'\" # OP - start of full description for a single option
222	.de OP
223	.LP
224	.nf
225	.ta 4c
226	Command-Line Name: \\fB\\$1\\fR
227	Database Name: \\fB\\$2\\fR
228	Database Class: \\fB\\$3\\fR
229	.fi
230	.IP
231	..
232	'\" # CS - begin code excerpt
233	.de CS
234	.RS
235	.nf
236	.ta .25i .5i .75i 1i
237	..
238	'\" # CE - end code excerpt
239	.de CE
240	.fi
241	.RE
242	..
243	.de UL
244	\\$1\l'\|0\(ul'\\$2
245	..
246	.TH Tcl_BackgroundError 3 7.5 Tcl "Tcl Library Procedures"
247	.BS
248	.SH NAME
249	Tcl_BackgroundError \- report Tcl error that occurred in background processing
250	.SH SYNOPSIS
251	.nf
252	\fB#include <tcl.h>\fR
253	.sp
254	\fBTcl_BackgroundError\fR(\fIinterp\fR)
255	.SH ARGUMENTS
256	.AS Tcl_Interp *interp
257	.AP Tcl_Interp *interp in
258	Interpreter in which the error occurred.
259	.BE
260
261	.SH DESCRIPTION
262	.PP
263	This procedure is typically invoked when a Tcl error occurs during
264	``background processing'' such as executing an event handler.
265	When such an error occurs, the error condition is reported to Tcl
266	or to a widget or some other C code, and there is not usually any
267	obvious way for that code to report the error to the user.
268	In these cases the code calls \fBTcl_BackgroundError\fR with an
269	\fIinterp\fR argument identifying the interpreter in which the
270	error occurred. At the time \fBTcl_BackgroundError\fR is invoked,
271	the interpreter's result is expected to contain an error message.
272	\fBTcl_BackgroundError\fR will invoke the \fBbgerror\fR
273	Tcl command to report the error in an application-specific fashion.
274	If no \fBbgerror\fR command exists, or if it returns with an error condition,
275	then \fBTcl_BackgroundError\fR reports the error itself by printing
276	a message on the standard error file.
277	.PP
278	\fBTcl_BackgroundError\fR does not invoke \fBbgerror\fR immediately
279	because this could potentially interfere with scripts that are in process
280	at the time the error occurred.
281	Instead, it invokes \fBbgerror\fR later as an idle callback.
282	\fBTcl_BackgroundError\fR saves the values of the \fBerrorInfo\fR and
283	\fBerrorCode\fR variables and restores these values just before
284	invoking \fBbgerror\fR.
285	.PP
286	It is possible for many background errors to accumulate before
287	\fBbgerror\fR is invoked. When this happens, each of the errors
288	is processed in order. However, if \fBbgerror\fR returns a
289	break exception, then all remaining error reports for the
290	interpreter are skipped.
291
292	.SH KEYWORDS
293	background, bgerror, error