Index: doc/current.3 =================================================================== diff -u -N -r216bad6f26882cfa3be0a4c37ce682ea312bf5c8 -r0228cdf0ec65ab129536c20196a05d593ceb59b4 --- doc/current.3 (.../current.3) (revision 216bad6f26882cfa3be0a4c37ce682ea312bf5c8) +++ doc/current.3 (.../current.3) (revision 0228cdf0ec65ab129536c20196a05d593ceb59b4) @@ -1,75 +1,82 @@ '\" -'\" Generated from file 'current.man' by tcllib/doctools with format 'nroff' -'\" Copyright (c) 2014 Stefan Sobernig , Gustaf Neumann ; available under the Creative Commons Attribution 3.0 Austria license (CC BY 3.0 AT). +'\" Generated from file 'current\&.man' by tcllib/doctools with format 'nroff' +'\" Copyright (c) 2014 Stefan Sobernig , Gustaf Neumann ; available under the Creative Commons Attribution 3\&.0 Austria license (CC BY 3\&.0 AT)\&. '\" -'\" 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.1 2009/01/30 04:56:47 andreas_kupries Exp $ -'\" -'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. +.TH "nx::current" 3 2\&.1\&.0 current "NX API" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # Start an argument description .de AP .ie !"\\$4"" .TP \\$4 .el \{\ @@ -78,7 +85,7 @@ .\} .ta \\n()Au \\n()Bu .ie !"\\$3"" \{\ -\&\\$1 \\fI\\$2\\fP (\\$3) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ @@ -91,7 +98,7 @@ .\} .\} .. -'\" # define tabbing values for .AP +.\" # define tabbing values for .AP .de AS .nr )A 10n .if !"\\$1"" .nr )A \\w'\\$1'u+3n @@ -101,9 +108,9 @@ .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 +.\" # BS - start boxed text +.\" # ^y = starting y location +.\" # ^b = 1 .de BS .br .mk ^y @@ -113,7 +120,7 @@ .if n \l'\\n(.lu\(ul' .if n .fi .. -'\" # BE - end boxed text (draw box now) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 @@ -133,16 +140,16 @@ .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ @@ -157,9 +164,9 @@ .\} .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. +.\" # 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 @@ -186,34 +193,36 @@ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf @@ -222,22 +231,45 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi +.IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. -.TH "nx::current" 3 2.0 current "" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME nx::current \- Return information about the method callstack @@ -249,75 +281,76 @@ .TP \fBcurrent\fR ?\fIoption\fR? This introspection command provides information about various details, -to be identified using \fIoption\fR, on the callstack. The command is -invoked from a method body. If \fIoption\fR is not provided, \fBnx::current\fR will -default to option \fBobject\fR (see below). \fBnx::current\fR operates on the +to be identified using \fIoption\fR, on the callstack\&. The command is +invoked from a method body\&. If \fIoption\fR is not provided, \fBnx::current\fR will +default to option \fBobject\fR (see below)\&. \fBnx::current\fR operates on the Tcl callstack and is aware of NX-specific callstack and stackframe -details. \fIoption\fR can be any of the following: +details\&. \fIoption\fR can be any of the following: .RS .IP \(bu \fBactivelevel\fR returns the actual callstack level which -calls into the currently executing method directly. This \fBactivelevel\fR might +calls into the currently executing method directly\&. This \fBactivelevel\fR might correspond the \fBcallinglevel\fR, but this is not necessarily -the case. The \fBactivelevel\fR also includes -intermediate calls, such as \fBnx::next\fR invocations. The level is +the case\&. The \fBactivelevel\fR also includes +intermediate calls, such as \fBnx::next\fR invocations\&. The level is reported as an absolute level number (# followed by a digit) to be -directly used as the first argument to \fBuplevel\fR or \fBupvar\fR. +directly used as the first argument to \fBuplevel\fR or \fBupvar\fR\&. .IP \(bu -\fBargs\fR returns the list of argument values passed into the currently executing method implementation. +\fBargs\fR returns the list of argument values passed into the currently executing method implementation\&. .IP \(bu \fBcalledclass\fR returns the name of the class that provides -the method implementation to which the intercepted method call is to be redirected (only available from within filter methods). +the method implementation to which the intercepted method call is to be redirected (only available from within filter methods)\&. .IP \(bu \fBcalledmethod\fR returns the original method name requested by intercepted method call (only available from within -filter methods). +filter methods)\&. .IP \(bu \fBcallingclass\fR returns the name of the class which provides the method implementation calling into the currently -executing method. See also \fBcallingobject\fR. +executing method\&. See also \fBcallingobject\fR\&. .IP \(bu \fBcallinglevel\fR resolves the callstack level of the originating invocation of the currently executing method -implementation. Callstack levels introduced by method interception -(e.g., filters) and by method combination (\fBnx::next\fR) are -ignored. The level is reported as an absolute level number (\fB#\fR followed +implementation\&. Callstack levels introduced by method interception +(e\&.g\&., filters) and by method combination (\fBnx::next\fR) are +ignored\&. The level is reported as an absolute level number (\fB#\fR followed by a digit) to be directly used as the first argument to \fBuplevel\fR -or \fBupvar\fR. See also \fBactivelevel\fR. +or \fBupvar\fR\&. See also \fBactivelevel\fR\&. .IP \(bu \fBcallingobject\fR returns the name of the object which is -calling into the currently executing method. See also \fBcallingclass\fR. +calling into the currently executing method\&. See also \fBcallingclass\fR\&. .IP \(bu \fBclass\fR returns the name of the class providing the -currently executing method implementation. The returned +currently executing method implementation\&. The returned method-providing class may be different to the class of the current -object. If called from within a method implementation provided by the -current object itself, an empty string is returned. +object\&. If called from within a method implementation provided by the +current object itself, an empty string is returned\&. .IP \(bu \fBfilterreg\fR returns the object (class) on which the currently executing method was registered as a filter method (only -available from within filter methods). +available from within filter methods)\&. .IP \(bu \fBisnextcall\fR will return 1, if the currently executing -method implementation was invoked via \fBnx::next\fR; 0 otherwise. +method implementation was invoked via \fBnx::next\fR; 0 otherwise\&. .IP \(bu \fBmethod\fR returns the name of the currently executing -method. If an ensemble-method call, the name of the bottom-most -("leaf") method is returned. +method\&. If an ensemble-method call, the name of the bottom-most +("leaf") method is returned\&. .IP \(bu \fBmethodpath\fR returns the combined name of the currently executing method (including all ensemble levels) in an -ensemble-method call. Otherwise, for a regular method call, the result -corresponds to the result of option \fBmethod\fR. +ensemble-method call\&. Otherwise, for a regular method call, the result +corresponds to the result of option \fBmethod\fR\&. .IP \(bu \fBnextmethod\fR returns the name of the next most -specific method implementation to be called when invoking \fBnx::next\fR. +specific method implementation to be called when invoking \fBnx::next\fR\&. .IP \(bu \fBobject\fR gives the name of the object on which the -currently executing method implementation is evaluated. +currently executing method implementation is evaluated\&. .RE .PP .SH COPYRIGHT .nf -Copyright (c) 2014 Stefan Sobernig , Gustaf Neumann ; available under the Creative Commons Attribution 3.0 Austria license (CC BY 3.0 AT). +Copyright (c) 2014 Stefan Sobernig , Gustaf Neumann ; available under the Creative Commons Attribution 3\&.0 Austria license (CC BY 3\&.0 AT)\&. + .fi \ No newline at end of file