Merged stubs changes into mainline for 8.0

6 files changed, 85 insertions, 18 deletions

diff --git a/doc/AddErrInfo.3 b/doc/AddErrInfo.3
index bf46867..b1820af 100644
--- a/doc/AddErrInfo.3
+++ b/doc/AddErrInfo.3
@@ -5,13 +5,13 @@
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\" 
-'\" RCS: @(#) $Id: AddErrInfo.3,v 1.2 1998/09/14 18:39:45 stanton Exp $
+'\" RCS: @(#) $Id: AddErrInfo.3,v 1.3 1999/03/10 05:52:45 stanton Exp $
 '\" 
 .so man.macros
 .TH Tcl_AddErrorInfo 3 7.5 Tcl "Tcl Library Procedures"
 .BS
 .SH NAME
-Tcl_AddObjErrorInfo, Tcl_AddErrorInfo, Tcl_SetErrorCode, Tcl_PosixError \- record information about errors
+Tcl_AddObjErrorInfo, Tcl_AddErrorInfo, Tcl_SetErrorCode, Tcl_SetErrorCodeVA, Tcl_PosixError \- record information about errors
 .SH SYNOPSIS
 .nf
 \fB#include <tcl.h>\fR
@@ -24,6 +24,8 @@ Tcl_AddObjErrorInfo, Tcl_AddErrorInfo, Tcl_SetErrorCode, Tcl_PosixError \- recor
 .sp
 \fBTcl_SetErrorCode\fR(\fIinterp, element, element, ... \fB(char *) NULL\fR)
 .sp
+\fBTcl_SetErrorCodeVA\fR(\fIinterp, argList\fR)
+.sp
 char *
 \fBTcl_PosixError\fR(\fIinterp\fR)
 .SH ARGUMENTS
@@ -47,6 +49,9 @@ This variable \fBerrorCode\fR will be set to this value.
 .AP char *element in
 String to record as one element of \fBerrorCode\fR variable.
 Last \fIelement\fR argument must be NULL.
+.AP va_list argList in
+An argument list which must have been initialised using
+\fBTCL_VARARGS_START\fR, and cleared using \fBva_end\fR.
 .BE
 
 .SH DESCRIPTION
@@ -118,6 +123,9 @@ The procedure \fBTcl_SetErrorCode\fR is also used to set the
 record instead of an object. Otherwise, it is similar to
 \fBTcl_SetObjErrorCode\fR in behavior.
 .PP
+\fBTcl_SetErrorCodeVA\fR is the same as \fBTcl_SetErrorCode\fR except that
+instead of taking a variable number of arguments it takes an argument list.
+.PP
 \fBTcl_PosixError\fR
 sets the \fBerrorCode\fR variable after an error in a POSIX kernel call.
 It reads the value of the \fBerrno\fR C variable and calls
diff --git a/doc/Eval.3 b/doc/Eval.3
index 4c7702e..42e77ae 100644
--- a/doc/Eval.3
+++ b/doc/Eval.3
@@ -5,13 +5,13 @@
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\" 
-'\" RCS: @(#) $Id: Eval.3,v 1.2 1998/09/14 18:39:48 stanton Exp $
+'\" RCS: @(#) $Id: Eval.3,v 1.3 1999/03/10 05:52:45 stanton Exp $
 '\" 
 .so man.macros
 .TH Tcl_Eval 3 7.0 Tcl "Tcl Library Procedures"
 .BS
 .SH NAME
-Tcl_Eval, Tcl_VarEval, Tcl_EvalFile, Tcl_GlobalEval \- execute Tcl commands
+Tcl_Eval, Tcl_VarEval, Tcl_VarEvalVA, Tcl_EvalFile, Tcl_GlobalEval \- execute Tcl commands
 .SH SYNOPSIS
 .nf
 \fB#include <tcl.h>\fR
@@ -23,6 +23,9 @@ int
 \fBTcl_VarEval\fR(\fIinterp, string, string, ... \fB(char *) NULL\fR)
 .sp
 int
+\fBTcl_VarEvalVA\fR(\fIinterp, argList\fR)
+.sp
+int
 \fBTcl_EvalFile\fR(\fIinterp, fileName\fR)
 .sp
 int
@@ -37,6 +40,9 @@ Command (or sequence of commands) to execute.  Must be in writable
 memory (\fBTcl_Eval\fR makes temporary modifications to the command).
 .AP char *string in
 String forming part of Tcl command.
+.AP va_list argList in
+An argument list which must have been initialised using
+\fBTCL_VARARGS_START\fR, and cleared using \fBva_end\fR.
 .AP char *fileName in
 Name of file containing Tcl command string.
 .BE
@@ -76,6 +82,9 @@ It returns the result of the command and also modifies
 The last argument to \fBTcl_VarEval\fR must be NULL to indicate the end
 of arguments.
 .PP
+\fBTcl_VarEvalVA\fR is the same as \fBTcl_VarEval\fR except that
+instead of taking a variable number of arguments it takes an argument list.
+.PP
 \fBTcl_EvalFile\fR reads the file given by \fIfileName\fR and evaluates
 its contents as a Tcl command by calling \fBTcl_Eval\fR.  It returns
 a standard Tcl result that reflects the result of evaluating the file.
diff --git a/doc/PkgRequire.3 b/doc/PkgRequire.3
index daec40b..796ee6f 100644
--- a/doc/PkgRequire.3
+++ b/doc/PkgRequire.3
@@ -4,13 +4,13 @@
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\" 
-'\" RCS: @(#) $Id: PkgRequire.3,v 1.2 1998/09/14 18:39:49 stanton Exp $
+'\" RCS: @(#) $Id: PkgRequire.3,v 1.3 1999/03/10 05:52:45 stanton Exp $
 '\" 
 .so man.macros
 .TH Tcl_PkgRequire 3 7.5 Tcl "Tcl Library Procedures"
 .BS
 .SH NAME
-Tcl_PkgRequire, Tcl_PkgProvide \- package version control
+Tcl_PkgRequire, Tcl_PkgRequireEx, Tcl_PkgPresent, Tcl_PkgPresentEx, Tcl_PkgProvide, Tcl_PkgProvideEx \- package version control
 .SH SYNOPSIS
 .nf
 \fB#include <tcl.h>\fR
@@ -18,10 +18,22 @@ Tcl_PkgRequire, Tcl_PkgProvide \- package version control
 char *
 \fBTcl_PkgRequire\fR(\fIinterp, name, version, exact\fR)
 .sp
+char *
+\fBTcl_PkgRequireEx\fR(\fIinterp, name, version, exact, clientDataPtr\fR)
+.sp
+char *
+\fBTcl_PkgPresent\fR(\fIinterp, name, version, exact\fR)
+.sp
+char *
+\fBTcl_PkgPresentEx\fR(\fIinterp, name, version, exact, clientDataPtr\fR)
+.sp
 int
 \fBTcl_PkgProvide\fR(\fIinterp, name, version\fR)
+.sp
+int
+\fBTcl_PkgProvideEx\fR(\fIinterp, name, version, clientData\fR)
 .SH ARGUMENTS
-.AS Tcl_FreeProc clientData
+.AS Tcl_FreeProc clientDataPtr
 .AP Tcl_Interp *interp in
 Interpreter where package is needed or available.
 .AP char *name in
@@ -35,25 +47,41 @@ Non-zero means that only the particular version specified by
 Zero means that newer versions than \fIversion\fR are also
 acceptable as long as they have the same major version number
 as \fIversion\fR.
+.AP ClientData clientData in
+Arbitrary value to be associated with the package.
+.AP ClientData *clientDataPtr out
+Pointer to place to store the value associated with the matching
+package. It is only changed if the pointer is not NULL and the
+function completed successfully.
 .BE
 
 .SH DESCRIPTION
 .PP
 These procedures provide C-level interfaces to Tcl's package and
 version management facilities.
+.PP
 \fBTcl_PkgRequire\fR is equivalent to the \fBpackage require\fR
+command, \fBTcl_PkgPresent\fR is equivalent to the \fBpackage present\fR
 command, and \fBTcl_PkgProvide\fR is equivalent to the
 \fBpackage provide\fR command.
+.PP
 See the documentation for the Tcl commands for details on what these
 procedures do.
-If \fBTcl_PkgRequire\fR completes successfully it returns a pointer
-to the version string for the version of the package that is provided
-in the interpreter (which may be different than \fIversion\fR); if
-an error occurs it returns NULL and leaves an error message in
-\fIinterp->result\fR.
+.PP
+If \fBTcl_PkgPresent\fR or \fBTcl_PkgRequire\fR complete successfully
+they return a pointer to the version string for the version of the package
+that is provided in the interpreter (which may be different than 
+\fIversion\fR); if an error occurs they return NULL and leave an error 
+message in \fIinterp->result\fR.
+.PP
 \fBTcl_PkgProvide\fR returns TCL_OK if it completes successfully;
 if an error occurs it returns TCL_ERROR and leaves an error message
 in \fIinterp->result\fR.
+.PP
+\fBTcl_PkgProvideEx\fR, \fBTcl_PkgPresentEx\fR and \fBTcl_PkgRequireEx\fR
+allow the setting and retrieving of the client data associated with
+the package. In all other respects they are equivalent to the matching
+functions.
 
 .SH KEYWORDS
-package, provide, require, version
+package, present, provide, require, version
diff --git a/doc/SetResult.3 b/doc/SetResult.3
index 7387a98..1fed065 100644
--- a/doc/SetResult.3
+++ b/doc/SetResult.3
@@ -5,13 +5,13 @@
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\" 
-'\" RCS: @(#) $Id: SetResult.3,v 1.2 1998/09/14 18:39:50 stanton Exp $
+'\" RCS: @(#) $Id: SetResult.3,v 1.3 1999/03/10 05:52:45 stanton Exp $
 '\" 
 .so man.macros
 .TH Tcl_SetResult 3 7.5 Tcl "Tcl Library Procedures"
 .BS
 .SH NAME
-Tcl_SetObjResult, Tcl_GetObjResult, Tcl_SetResult, Tcl_GetStringResult, Tcl_AppendResult, Tcl_AppendElement, Tcl_ResetResult \- manipulate Tcl result
+Tcl_SetObjResult, Tcl_GetObjResult, Tcl_SetResult, Tcl_GetStringResult, Tcl_AppendResult, Tcl_AppendResultVA, Tcl_AppendElement, Tcl_ResetResult \- manipulate Tcl result
 .SH SYNOPSIS
 .nf
 \fB#include <tcl.h>\fR
@@ -28,6 +28,8 @@ char *
 .sp
 \fBTcl_AppendResult\fR(\fIinterp, string, string, ... , \fB(char *) NULL\fR)
 .sp
+\fBTcl_AppendResultVA\fR(\fIinterp, argList\fR)
+.sp
 \fBTcl_AppendElement\fR(\fIinterp, string\fR)
 .sp
 \fBTcl_ResetResult\fR(\fIinterp\fR)
@@ -46,6 +48,9 @@ appended to the existing result.
 Address of procedure to call to release storage at
 \fIstring\fR, or \fBTCL_STATIC\fR, \fBTCL_DYNAMIC\fR, or
 \fBTCL_VOLATILE\fR.
+.AP va_list argList in
+An argument list which must have been initialised using
+\fBTCL_VARARGS_START\fR, and cleared using \fBva_end\fR.
 .BE
 
 .SH DESCRIPTION
@@ -137,6 +142,9 @@ to a string, if necessary, before appending the argument strings.
 Any number of \fIstring\fR arguments may be passed in a single
 call; the last argument in the list must be a NULL pointer.
 .PP
+\fBTcl_AppendResultVA\fR is the same as \fBTcl_AppendResult\fR except that
+instead of taking a variable number of arguments it takes an argument list.
+.PP
 \fBTcl_AppendElement\fR is similar to \fBTcl_AppendResult\fR in
 that it allows results to be built up in pieces.
 However, \fBTcl_AppendElement\fR takes only a single \fIstring\fR
diff --git a/doc/StringObj.3 b/doc/StringObj.3
index bd44170..94cd142 100644
--- a/doc/StringObj.3
+++ b/doc/StringObj.3
@@ -4,13 +4,13 @@
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\" 
-'\" RCS: @(#) $Id: StringObj.3,v 1.2 1998/09/14 18:39:50 stanton Exp $
+'\" RCS: @(#) $Id: StringObj.3,v 1.3 1999/03/10 05:52:45 stanton Exp $
 '\" 
 .so man.macros
 .TH Tcl_StringObj 3 8.0 Tcl "Tcl Library Procedures"
 .BS
 .SH NAME
-Tcl_NewStringObj, Tcl_SetStringObj, Tcl_GetStringFromObj, Tcl_AppendToObj, Tcl_AppendStringsToObj, Tcl_SetObjLength, TclConcatObj \- manipulate Tcl objects as strings
+Tcl_NewStringObj, Tcl_SetStringObj, Tcl_GetStringFromObj, Tcl_AppendToObj, Tcl_AppendStringsToObj, Tcl_AppendStringsToObjVA, Tcl_SetObjLength, TclConcatObj \- manipulate Tcl objects as strings
 .SH SYNOPSIS
 .nf
 \fB#include <tcl.h>\fR
@@ -27,6 +27,8 @@ char *
 .sp
 \fBTcl_AppendStringsToObj\fR(\fIobjPtr, string, string, ... \fB(char *) NULL\fR)
 .sp
+\fBTcl_AppendStringsToObjVA\fR(\fIobjPtr, argList\fR)
+.sp
 \fBTcl_SetObjLength\fR(\fIobjPtr, newLength\fR)
 .sp
 Tcl_Obj *
@@ -49,6 +51,9 @@ If non-NULL, the location where \fBTcl_GetStringFromObj\fR will store
 the the length of an object's string representation.
 .AP char *string in
 Null-terminated string value to append to \fIobjPtr\fR.
+.AP va_list argList in
+An argument list which must have been initialised using
+\fBTCL_VARARGS_START\fR, and cleared using \fBva_end\fR.
 .AP int newLength in
 New length for the string value of \fIobjPtr\fR, not including the
 final NULL character.
@@ -99,6 +104,10 @@ values may contain internal null characters).  Any number of
 \fIstring\fR arguments may be provided, but the last argument
 must be a NULL pointer to indicate the end of the list.
 .PP
+\fBTcl_AppendStringsToObjVA\fR is the same as \fBTcl_AppendStringsToObj\fR
+except that instead of taking a variable number of arguments it takes an
+argument list.
+.PP
 The \fBTcl_SetObjLength\fR procedure changes the length of the
 string value of its \fIobjPtr\fR argument.  If the \fInewLength\fR
 argument is greater than the space allocated for the object's
diff --git a/doc/package.n b/doc/package.n
index 2a1b399..f4d9f84 100644
--- a/doc/package.n
+++ b/doc/package.n
@@ -4,7 +4,7 @@
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\" 
-'\" RCS: @(#) $Id: package.n,v 1.2 1998/09/14 18:39:54 stanton Exp $
+'\" RCS: @(#) $Id: package.n,v 1.3 1999/03/10 05:52:45 stanton Exp $
 '\" 
 .so man.macros
 .TH package n 7.5 Tcl "Tcl Built-In Commands"
@@ -17,6 +17,7 @@ package \- Facilities for package loading and version control
 \fBpackage forget \fIpackage\fR
 \fBpackage ifneeded \fIpackage version\fR ?\fIscript\fR?
 \fBpackage names\fR
+\fBpackage present \fR?\fB\-exact\fR? \fIpackage \fR?\fIversion\fR?
 \fBpackage provide \fIpackage \fR?\fIversion\fR?
 \fBpackage require \fR?\fB\-exact\fR? \fIpackage \fR?\fIversion\fR?
 \fBpackage unknown \fR?\fIcommand\fR?
@@ -75,6 +76,10 @@ interpreter for which a version has been provided (via
 script is available.
 The order of elements in the list is arbitrary.
 .TP
+\fBpackage present \fR?\fB\-exact\fR? \fIpackage \fR?\fIversion\fR?
+This command is equivalent to \fBpackage require\fR except that it
+does not try and load the package if it is not already loaded.
+.TP
 \fBpackage provide \fIpackage \fR?\fIversion\fR?
 This command is invoked to indicate that version \fIversion\fR
 of package \fIpackage\fR is now present in the interpreter.