| '\" |
| '\" See the file "license.terms" for information on usage and redistribution |
| '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. |
| '\" |
| '\" RCS: @(#) $Id: Panic.3,v 1.3 2003/01/21 19:39:59 hunt 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_Panic 3 8.4 Tcl "Tcl Library Procedures" |
| .BS |
| '\" Note: do not modify the .SH NAME line immediately below! |
| .SH NAME |
| Tcl_Panic, Tcl_PanicVA, Tcl_SetPanicProc, panic, panicVA \- report fatal error and abort |
| .SH SYNOPSIS |
| .nf |
| \fB#include <tcl.h>\fR |
| .sp |
| void |
| \fBTcl_Panic\fR(\fIformat\fR, \fIarg\fR, \fIarg\fR, \fI...\fR) |
| .sp |
| void |
| \fBTcl_PanicVA\fR(\fIformat\fR, \fIargList\fR) |
| .sp |
| void |
| \fBTcl_SetPanicProc\fR(\fIpanicProc\fR) |
| .sp |
| void |
| \fBpanic\fR(\fIformat\fR, \fIarg\fR, \fIarg\fR, \fI...\fR) |
| .sp |
| void |
| \fBpanicVA\fR(\fIformat\fR, \fIargList\fR) |
| .sp |
| .SH ARGUMENTS |
| .AS Tcl_PanicProc *panicProc |
| .AP "CONST char*" format in |
| A printf-style format string. |
| .AP "" arg in |
| Arguments matching the format string. |
| .AP va_list argList in |
| An argument list of arguments matching the format string. |
| Must have been initialized using \fBTCL_VARARGS_START\fR, |
| and cleared using \fBva_end\fR. |
| .AP Tcl_PanicProc *panicProc in |
| Procedure to report fatal error message and abort. |
| |
| .BE |
| |
| .SH DESCRIPTION |
| .PP |
| When the Tcl library detects that its internal data structures are in an |
| inconsistent state, or that its C procedures have been called in a |
| manner inconsistent with their documentation, it calls \fBTcl_Panic\fR |
| to display a message describing the error and abort the process. The |
| \fIformat\fR argument is a format string describing how to format the |
| remaining arguments \fIarg\fR into an error message, according to the |
| same formatting rules used by the \fBprintf\fR family of functions. The |
| same formatting rules are also used by the builtin Tcl command |
| \fBformat\fR. |
| .PP |
| In a freshly loaded Tcl library, \fBTcl_Panic\fR prints the formatted |
| error message to the standard error file of the process, and then |
| calls \fBabort\fR to terminate the process. \fBTcl_Panic\fR does not |
| return. |
| .PP |
| \fBTcl_SetPanicProc\fR may be used to modify the behavior of |
| \fBTcl_Panic\fR. The \fIpanicProc\fR argument should match the |
| type \fBTcl_PanicProc\fR: |
| .PP |
| .CS |
| typedef void Tcl_PanicProc( |
| CONST char *\fBformat\fR, |
| \fBarg\fR, \fBarg\fR,...); |
| .CE |
| .PP |
| After \fBTcl_SetPanicProc\fR returns, any future calls to |
| \fBTcl_Panic\fR will call \fIpanicProc\fR, passing along the |
| \fIformat\fR and \fIarg\fR arguments. To maintain consistency with the |
| callers of \fBTcl_Panic\fR, \fIpanicProc\fR must not return; it must |
| call \fBabort\fR. \fIpanicProc\fR should avoid making calls into the |
| Tcl library, or into other libraries that may call the Tcl library, |
| since the original call to \fBTcl_Panic\fR indicates the Tcl library is |
| not in a state of reliable operation. |
| .PP |
| The typical use of \fBTcl_SetPanicProc\fR arranges for the error message |
| to be displayed or reported in a manner more suitable for the |
| application or the platform. As an example, the Windows implementation |
| of \fBwish\fR calls \fBTcl_SetPanicProc\fR to force all panic messages |
| to be displayed in a system dialog box, rather than to be printed to the |
| standard error file (usually not visible under Windows). |
| .PP |
| Although the primary callers of \fBTcl_Panic\fR are the procedures of |
| the Tcl library, \fBTcl_Panic\fR is a public function and may be called |
| by any extension or application that wishes to abort the process and |
| have a panic message displayed the same way that panic messages from Tcl |
| will be displayed. |
| .PP |
| \fBTcl_PanicVA\fR is the same as \fBTcl_Panic\fR except that instead of |
| taking a variable number of arguments it takes an argument list. The |
| procedures \fBpanic\fR and \fBpanicVA\fR are synonyms (implemented as |
| macros) for \fBTcl_Panic\fR and \fBTcl_PanicVA\fR, respectively. They |
| exist to support old code; new code should use direct calls to |
| \fBTcl_Panic\fR or \fBTcl_PanicVA\fR. |
| |
| .SH "SEE ALSO" |
| abort(3), printf(3), exec(n), format(n) |
| |
| .SH KEYWORDS |
| abort, fatal, error |
| |