diff options
| author | dkf <donal.k.fellows@manchester.ac.uk> | 2004-10-07 15:15:18 (GMT) |
|---|---|---|
| committer | dkf <donal.k.fellows@manchester.ac.uk> | 2004-10-07 15:15:18 (GMT) |
| commit | b28ec5359a9e725985e869eb7c60b4d68637aa42 (patch) | |
| tree | 40c7dac00a9e649ae1eba8fb339d581f28845b74 | |
| parent | 4d7bec4bb09136c9340a8506acb17ce671efbd20 (diff) | |
| download | tcl-b28ec5359a9e725985e869eb7c60b4d68637aa42.zip tcl-b28ec5359a9e725985e869eb7c60b4d68637aa42.tar.gz tcl-b28ec5359a9e725985e869eb7c60b4d68637aa42.tar.bz2 | |
Convert CONST to const, VOID to void so we document how we want the API used.
55 files changed, 246 insertions, 240 deletions
@@ -14,6 +14,10 @@ 2004-10-07 Donal K. Fellows <donal.k.fellows@man.ac.uk> + * *.3: Convert CONST to const and VOID to void so we document how + people should actually use the Tcl API and not the compatability + hacks that it has to have. + * doc/man.macros, *.3: Update .AS macro so it can know how wide to make the third column of the argument list. Update documentation for C API (only users) to take advantage of this. diff --git a/doc/AddErrInfo.3 b/doc/AddErrInfo.3 index 1ce977b..b7a388c 100644 --- a/doc/AddErrInfo.3 +++ b/doc/AddErrInfo.3 @@ -5,7 +5,7 @@ '\" 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.10 2004/10/07 14:44:31 dkf Exp $ +'\" RCS: @(#) $Id: AddErrInfo.3,v 1.11 2004/10/07 15:15:35 dkf Exp $ '\" .so man.macros .TH Tcl_AddErrorInfo 3 8.0 Tcl "Tcl Library Procedures" @@ -26,7 +26,7 @@ Tcl_AddObjErrorInfo, Tcl_AddErrorInfo, Tcl_SetObjErrorCode, Tcl_SetErrorCode, Tc .sp \fBTcl_SetErrorCodeVA\fR(\fIinterp, argList\fR) .sp -CONST char * +const char * \fBTcl_PosixError\fR(\fIinterp\fR) .sp void @@ -55,9 +55,9 @@ Last \fIelement\fR argument must be NULL. .AP va_list argList in An argument list which must have been initialized using \fBTCL_VARARGS_START\fR, and cleared using \fBva_end\fR. -.AP "CONST char" *script in +.AP "const char" *script in Pointer to first character in script containing command (must be <= command) -.AP "CONST char" *command in +.AP "const char" *command in Pointer to first character in command that generated the error .AP int commandLength in Number of bytes in command; -1 means use all bytes up to first null byte diff --git a/doc/AssocData.3 b/doc/AssocData.3 index edc91dc..6fb16ed 100644 --- a/doc/AssocData.3 +++ b/doc/AssocData.3 @@ -5,7 +5,7 @@ '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" '\" -'\" RCS: @(#) $Id: AssocData.3,v 1.6 2004/10/07 14:44:31 dkf Exp $ +'\" RCS: @(#) $Id: AssocData.3,v 1.7 2004/10/07 15:15:35 dkf Exp $ .so man.macros .TH Tcl_SetAssocData 3 7.5 Tcl "Tcl Library Procedures" .BS @@ -25,7 +25,7 @@ ClientData .AS Tcl_InterpDeleteProc **delProcPtr .AP Tcl_Interp *interp in Interpreter in which to execute the specified command. -.AP "CONST char" *key in +.AP "const char" *key in Key for association with which to store data or from which to delete or retrieve data. Typically the module prefix for a package. .AP Tcl_InterpDeleteProc *delProc in diff --git a/doc/ByteArrObj.3 b/doc/ByteArrObj.3 index 5e36416..e7cc023 100644 --- a/doc/ByteArrObj.3 +++ b/doc/ByteArrObj.3 @@ -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: ByteArrObj.3,v 1.5 2004/10/07 14:44:31 dkf Exp $ +'\" RCS: @(#) $Id: ByteArrObj.3,v 1.6 2004/10/07 15:15:35 dkf Exp $ '\" .so man.macros .TH Tcl_ByteArrayObj 3 8.1 Tcl "Tcl Library Procedures" @@ -27,8 +27,8 @@ unsigned char * unsigned char * \fBTcl_SetByteArrayLength\fR(\fIobjPtr, length\fR) .SH ARGUMENTS -.AS "CONST unsigned char" *lengthPtr in/out -.AP "CONST unsigned char" *bytes in +.AS "const unsigned char" *lengthPtr in/out +.AP "const unsigned char" *bytes in The array of bytes used to initialize or set a byte-array object. .AP int length in The length of the array of bytes. It must be >= 0. diff --git a/doc/CmdCmplt.3 b/doc/CmdCmplt.3 index 718bdf0..152655a 100644 --- a/doc/CmdCmplt.3 +++ b/doc/CmdCmplt.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: CmdCmplt.3,v 1.3 2002/08/05 03:24:39 dgp Exp $ +'\" RCS: @(#) $Id: CmdCmplt.3,v 1.4 2004/10/07 15:15:35 dkf Exp $ '\" .so man.macros .TH Tcl_CommandComplete 3 "" Tcl "Tcl Library Procedures" @@ -19,8 +19,8 @@ Tcl_CommandComplete \- Check for unmatched braces in a Tcl command int \fBTcl_CommandComplete\fR(\fIcmd\fR) .SH ARGUMENTS -.AS "CONST char" *cmd -.AP "CONST char" *cmd in +.AS "const char" *cmd +.AP "const char" *cmd in Command string to test for completeness. .BE diff --git a/doc/Concat.3 b/doc/Concat.3 index 60fb044..168d411 100644 --- a/doc/Concat.3 +++ b/doc/Concat.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: Concat.3,v 1.6 2004/10/07 14:44:31 dkf Exp $ +'\" RCS: @(#) $Id: Concat.3,v 1.7 2004/10/07 15:15:35 dkf Exp $ '\" .so man.macros .TH Tcl_Concat 3 7.5 Tcl "Tcl Library Procedures" @@ -16,13 +16,13 @@ Tcl_Concat \- concatenate a collection of strings .nf \fB#include <tcl.h>\fR .sp -CONST char * +const char * \fBTcl_Concat\fR(\fIargc, argv\fR) .SH ARGUMENTS -.AS "CONST char * CONST" argv[] +.AS "const char *const" argv[] .AP int argc in Number of strings. -.AP "CONST char * CONST" argv[] in +.AP "const char *const" argv[] in Array of strings to concatenate. Must have \fIargc\fR entries. .BE diff --git a/doc/CrtChannel.3 b/doc/CrtChannel.3 index a714638..1ba7cf8 100644 --- a/doc/CrtChannel.3 +++ b/doc/CrtChannel.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: CrtChannel.3,v 1.21 2004/10/07 14:44:31 dkf Exp $ +'\" RCS: @(#) $Id: CrtChannel.3,v 1.22 2004/10/07 15:15:35 dkf Exp $ .so man.macros .TH Tcl_CreateChannel 3 8.3 Tcl "Tcl Library Procedures" .BS @@ -25,7 +25,7 @@ ClientData Tcl_ChannelType * \fBTcl_GetChannelType\fR(\fIchannel\fR) .sp -CONST char * +const char * \fBTcl_GetChannelName\fR(\fIchannel\fR) .sp int @@ -69,7 +69,7 @@ void int \fBTcl_ChannelBuffered\fR(\fIchannel\fR) .sp -CONST char * +const char * \fBTcl_ChannelName\fR(\fItypePtr\fR) .sp Tcl_ChannelTypeVersion @@ -121,7 +121,7 @@ Tcl_DriverHandlerProc * .AP Tcl_ChannelType *typePtr in Points to a structure containing the addresses of procedures that can be called to perform I/O and other functions on the channel. -.AP "CONST char" *channelName in +.AP "const char" *channelName in The name of this channel, such as \fBfile3\fR; must not be in use by any other channel. Can be NULL, in which case the channel is created without a name. @@ -147,9 +147,9 @@ and \fBTCL_EXCEPTION\fR that indicates events that have occurred on this channel. .AP Tcl_Interp *interp in Current interpreter. (can be NULL) -.AP "CONST char" *optionName in +.AP "const char" *optionName in Name of the invalid option. -.AP "CONST char" *optionList in +.AP "const char" *optionList in Specific options list (space separated words, without "-") to append to the standard generic options list. Can be NULL for generic options error message only. @@ -515,7 +515,7 @@ generic layer to transfer data from an internal buffer to the output device. .CS typedef int Tcl_DriverOutputProc( ClientData \fIinstanceData\fR, - CONST char *\fIbuf\fR, + const char *\fIbuf\fR, int \fItoWrite\fR, int *\fIerrorCodePtr\fR); .CE @@ -609,8 +609,8 @@ the generic layer to set a channel type specific option on a channel. typedef int Tcl_DriverSetOptionProc( ClientData \fIinstanceData\fR, Tcl_Interp *\fIinterp\fR, - CONST char *\fIoptionName\fR, - CONST char *\fInewValue\fR); + const char *\fIoptionName\fR, + const char *\fInewValue\fR); .CE .PP \fIoptionName\fR is the name of an option to set, and \fInewValue\fR is @@ -650,7 +650,7 @@ channel. \fIgetOptionProc\fR must match the following prototype: typedef int Tcl_DriverGetOptionProc( ClientData \fIinstanceData\fR, Tcl_Interp *\fIinterp\fR, - CONST char *\fIoptionName\fR, + const char *\fIoptionName\fR, Tcl_DString *\fIoptionValue\fR); .CE .PP diff --git a/doc/CrtCommand.3 b/doc/CrtCommand.3 index 9152b6b..5cabe10 100644 --- a/doc/CrtCommand.3 +++ b/doc/CrtCommand.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: CrtCommand.3,v 1.9 2004/10/07 14:44:31 dkf Exp $ +'\" RCS: @(#) $Id: CrtCommand.3,v 1.10 2004/10/07 15:15:35 dkf Exp $ '\" .so man.macros .TH Tcl_CreateCommand 3 "" Tcl "Tcl Library Procedures" @@ -22,7 +22,7 @@ Tcl_Command .AS Tcl_CmdDeleteProc *deleteProc .AP Tcl_Interp *interp in Interpreter in which to create new command. -.AP "CONST char" *cmdName in +.AP "const char" *cmdName in Name of command. .AP Tcl_CmdProc *proc in Implementation of new command: \fIproc\fR will be called whenever @@ -82,7 +82,7 @@ typedef int Tcl_CmdProc( ClientData \fIclientData\fR, Tcl_Interp *\fIinterp\fR, int \fIargc\fR, - CONST char *\fIargv\fR[]); + const char *\fIargv\fR[]); .CE When \fIproc\fR is invoked the \fIclientData\fR and \fIinterp\fR parameters will be copies of the \fIclientData\fR and \fIinterp\fR diff --git a/doc/CrtMathFnc.3 b/doc/CrtMathFnc.3 index 5c4d54e..2a23130 100644 --- a/doc/CrtMathFnc.3 +++ b/doc/CrtMathFnc.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: CrtMathFnc.3,v 1.10 2004/10/07 14:44:31 dkf Exp $ +'\" RCS: @(#) $Id: CrtMathFnc.3,v 1.11 2004/10/07 15:15:35 dkf Exp $ '\" .so man.macros .TH Tcl_CreateMathFunc 3 8.4 Tcl "Tcl Library Procedures" @@ -31,7 +31,7 @@ Tcl_Obj * .AS Tcl_ValueType *clientDataPtr out .AP Tcl_Interp *interp in Interpreter in which new function will be defined. -.AP "CONST char" *name in +.AP "const char" *name in Name for new function. .AP int numArgs in Number of arguments to new function; also gives size of \fIargTypes\fR array. @@ -57,7 +57,7 @@ implemented directly in bytecode). Points to a variable that will be set to contain the clientData argument passed to \fITcl_CreateMathFunc\fR when the function was created if the function is not implemented directly in bytecode. -.AP "CONST char" *pattern in +.AP "const char" *pattern in Pattern to match against function names so as to filter them (by passing to \fITcl_StringMatch\fR), or NULL to not apply any filter. .BE diff --git a/doc/CrtObjCmd.3 b/doc/CrtObjCmd.3 index 0f44e1d..18e417c 100644 --- a/doc/CrtObjCmd.3 +++ b/doc/CrtObjCmd.3 @@ -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: CrtObjCmd.3,v 1.10 2004/10/07 14:44:32 dkf Exp $ +'\" RCS: @(#) $Id: CrtObjCmd.3,v 1.11 2004/10/07 15:15:36 dkf Exp $ '\" .so man.macros .TH Tcl_CreateObjCommand 3 8.0 Tcl "Tcl Library Procedures" @@ -39,7 +39,7 @@ int .VE .sp .VS 8.4 -CONST char * +const char * .VE \fBTcl_GetCommandName\fR(\fIinterp, token\fR) .sp @@ -100,7 +100,7 @@ typedef int Tcl_ObjCmdProc( Tcl_Interp *\fIinterp\fR, int \fIobjc\fR, .VS - Tcl_Obj *CONST \fIobjv\fR[]); + Tcl_Obj *const \fIobjv\fR[]); .CE When \fIproc\fR is invoked, the \fIclientData\fR and \fIinterp\fR parameters will be copies of the \fIclientData\fR and \fIinterp\fR arguments given to diff --git a/doc/CrtSlave.3 b/doc/CrtSlave.3 index 58a6d27..e99c2cf 100644 --- a/doc/CrtSlave.3 +++ b/doc/CrtSlave.3 @@ -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: CrtSlave.3,v 1.12 2004/10/07 14:44:32 dkf Exp $ +'\" RCS: @(#) $Id: CrtSlave.3,v 1.13 2004/10/07 15:15:36 dkf Exp $ '\" .so man.macros .TH Tcl_CreateSlave 3 7.6 Tcl "Tcl Library Procedures" @@ -58,7 +58,7 @@ int .AS Tcl_InterpDeleteProc **targetInterpPtr out .AP Tcl_Interp *interp in Interpreter in which to execute the specified command. -.AP "CONST char" *slaveName in +.AP "const char" *slaveName in Name of slave interpreter to create or manipulate. .AP int isSafe in If non-zero, a ``safe'' slave that is suitable for running untrusted code @@ -66,15 +66,15 @@ is created, otherwise a trusted slave is created. .AP Tcl_Interp *slaveInterp in Interpreter to use for creating the source command for an alias (see below). -.AP "CONST char" *slaveCmd in +.AP "const char" *slaveCmd in Name of source command for alias. .AP Tcl_Interp *targetInterp in Interpreter that contains the target command for an alias. -.AP "CONST char" *targetCmd in +.AP "const char" *targetCmd in Name of target command for alias in \fItargetInterp\fR. .AP int argc in Count of additional arguments to pass to the alias command. -.AP "CONST char * CONST" *argv in +.AP "const char *const" *argv in Vector of strings, the additional arguments to pass to the alias command. This storage is owned by the caller. .AP int objc in @@ -86,13 +86,13 @@ This storage is owned by the caller. .AP Tcl_Interp **targetInterpPtr in Pointer to location to store the address of the interpreter where a target command is defined for an alias. -.AP "CONST char" **targetCmdPtr out +.AP "const char" **targetCmdPtr out Pointer to location to store the address of the name of the target command for an alias. .AP int *argcPtr out Pointer to location to store count of additional arguments to be passed to the alias. The location is in storage owned by the caller. -.AP "CONST char" ***argvPtr out +.AP "const char" ***argvPtr out Pointer to location to store a vector of strings, the additional arguments to pass to an alias. The location is in storage owned by the caller, the vector of strings is owned by the called function. @@ -104,9 +104,9 @@ Pointer to location to store a vector of Tcl_Obj structures, the additional arguments to pass to an object alias command. The location is in storage owned by the caller, the vector of Tcl_Obj structures is owned by the called function. -.AP "CONST char" *cmdName in +.AP "const char" *cmdName in Name of an exposed command to hide or create. -.AP "CONST char" *hiddenCmdName in +.AP "const char" *hiddenCmdName in Name under which a hidden command is stored and with which it can be exposed or invoked. .BE diff --git a/doc/CrtTrace.3 b/doc/CrtTrace.3 index bf1c19d..0d54bff 100644 --- a/doc/CrtTrace.3 +++ b/doc/CrtTrace.3 @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: CrtTrace.3,v 1.8 2004/10/07 14:44:32 dkf Exp $ +'\" RCS: @(#) $Id: CrtTrace.3,v 1.9 2004/10/07 15:15:36 dkf Exp $ '\" .so man.macros .TH Tcl_CreateTrace 3 "" Tcl "Tcl Library Procedures" @@ -70,10 +70,10 @@ typedef int \fBTcl_CmdObjTraceProc\fR( \fBClientData\fR \fIclientData\fR, \fBTcl_Interp\fR* \fIinterp\fR, int \fIlevel\fR, - CONST char* \fIcommand\fR, + const char *\fIcommand\fR, \fBTcl_Command\fR \fIcommandToken\fR, int \fIobjc\fR, - \fBTcl_Obj\fR *CONST \fIobjv\fR[] ); + \fBTcl_Obj\fR *const \fIobjv\fR[] ); .CE The \fIclientData\fR and \fIinterp\fR parameters are copies of the corresponding arguments given to \fBTcl_CreateTrace\fR. @@ -164,7 +164,7 @@ typedef void Tcl_CmdTraceProc( Tcl_CmdProc *\fIcmdProc\fR, ClientData \fIcmdClientData\fR, int \fIargc\fR, - CONST char *\fIargv\fR[]); + const char *\fIargv\fR[]); .CE The parameters to the \fIproc\fR callback are similar to those of the \fIobjProc\fR callback above. The \fIcommandToken\fR is diff --git a/doc/DString.3 b/doc/DString.3 index ac37e0a..e5d5e33 100644 --- a/doc/DString.3 +++ b/doc/DString.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: DString.3,v 1.10 2004/10/07 14:44:32 dkf Exp $ +'\" RCS: @(#) $Id: DString.3,v 1.11 2004/10/07 15:15:36 dkf Exp $ '\" .so man.macros .TH Tcl_DString 3 7.4 Tcl "Tcl Library Procedures" @@ -47,7 +47,7 @@ char * .AS Tcl_DString newLength in/out .AP Tcl_DString *dsPtr in/out Pointer to structure that is used to manage a dynamic string. -.AP "CONST char" *string in +.AP "const char" *string in Pointer to characters to add to dynamic string. .AP int length in Number of characters from string to add to dynamic string. If -1, diff --git a/doc/DictObj.3 b/doc/DictObj.3 index fd301bb..fb9206e 100644 --- a/doc/DictObj.3 +++ b/doc/DictObj.3 @@ -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: DictObj.3,v 1.7 2004/10/07 14:44:32 dkf Exp $ +'\" RCS: @(#) $Id: DictObj.3,v 1.8 2004/10/07 15:15:36 dkf Exp $ '\" .so man.macros .TH Tcl_DictObj 3 8.5 Tcl "Tcl Library Procedures" @@ -89,7 +89,7 @@ completed, and a zero otherwise. .AP int keyc in Indicates the number of keys that will be supplied in the \fIkeyv\fR array. -.AP "Tcl_Obj *CONST" *keyv in +.AP "Tcl_Obj *const" *keyv in Array of \fIkeyc\fR pointers to objects that \fBTcl_DictObjPutKeyList\fR and \fBTcl_DictObjRemoveKeyList\fR will use to locate the key/value pair to manipulate within the diff --git a/doc/DumpActiveMemory.3 b/doc/DumpActiveMemory.3 index 9968fab..bdab746 100644 --- a/doc/DumpActiveMemory.3 +++ b/doc/DumpActiveMemory.3 @@ -3,7 +3,7 @@ '\" Copyright (c) 2000 by Scriptics Corporation. '\" All rights reserved. '\" -'\" RCS: @(#) $Id: DumpActiveMemory.3,v 1.7 2004/10/07 14:44:32 dkf Exp $ +'\" RCS: @(#) $Id: DumpActiveMemory.3,v 1.8 2004/10/07 15:15:36 dkf Exp $ '\" .so man.macros .TH "Tcl_DumpActiveMemory" 3 8.1 Tcl "Tcl Library Procedures" @@ -27,7 +27,7 @@ void .AS Tcl_Interp *fileName .AP Tcl_Interp *interp in Tcl interpreter in which to add commands. -.AP "CONST char" *fileName in +.AP "const char" *fileName in For \fBTcl_DumpActiveMemory\fR, name of the file to which memory information will be written. For \fBTcl_ValidateAllMemory\fR, name of the file from which the call is being made (normally \fB__FILE__\fR). diff --git a/doc/Encoding.3 b/doc/Encoding.3 index 658f081..c365aaf 100644 --- a/doc/Encoding.3 +++ b/doc/Encoding.3 @@ -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: Encoding.3,v 1.19 2004/10/07 14:52:43 dkf Exp $ +'\" RCS: @(#) $Id: Encoding.3,v 1.20 2004/10/07 15:15:37 dkf Exp $ '\" .so man.macros .TH Tcl_GetEncoding 3 "8.1" Tcl "Tcl Library Procedures" @@ -41,7 +41,7 @@ char * TCHAR * \fBTcl_WinUtfToTChar\fR(\fIsrc, srcLen, dstPtr\fR) .sp -CONST char * +const char * \fBTcl_GetEncodingName\fR(\fIencoding\fR) .sp int @@ -53,7 +53,7 @@ void Tcl_Encoding \fBTcl_CreateEncoding\fR(\fItypePtr\fR) .sp -CONST char * +const char * \fBTcl_GetDefaultEncodingDir\fR(\fIvoid\fR) .sp void @@ -64,17 +64,17 @@ void .AP Tcl_Interp *interp in Interpreter to use for error reporting, or NULL if no error reporting is desired. -.AP "CONST char" *name in +.AP "const char" *name in Name of encoding to load. .AP Tcl_Encoding encoding in The encoding to query, free, or use for converting text. If \fIencoding\fR is NULL, the current system encoding is used. -.AP "CONST char" *src in +.AP "const char" *src in For the \fBTcl_ExternalToUtf\fR functions, an array of bytes in the specified encoding that are to be converted to UTF-8. For the \fBTcl_UtfToExternal\fR and \fBTcl_WinUtfToTChar\fR functions, an array of UTF-8 characters to be converted to the specified encoding. -.AP "CONST TCHAR" *tsrc in +.AP "const TCHAR" *tsrc in An array of Windows TCHAR characters to convert to UTF-8. .AP int srcLen in Length of \fIsrc\fR or \fItsrc\fR in bytes. If the length is negative, the @@ -123,7 +123,7 @@ Filled with the number of characters that correspond to the number of bytes stored in the output buffer. May be NULL. .AP Tcl_EncodingType *typePtr in Structure that defines a new type of encoding. -.AP "CONST char" *path in +.AP "const char" *path in A path to the location of the encoding file. .BE .SH INTRODUCTION @@ -303,7 +303,7 @@ convert between this encoding and UTF-8. It is defined as follows: .PP .CS typedef struct Tcl_EncodingType { - CONST char *\fIencodingName\fR; + const char *\fIencodingName\fR; Tcl_EncodingConvertProc *\fItoUtfProc\fR; Tcl_EncodingConvertProc *\fIfromUtfProc\fR; Tcl_EncodingFreeProc *\fIfreeProc\fR; @@ -339,7 +339,7 @@ type \fBTcl_EncodingConvertProc\fR: .CS typedef int Tcl_EncodingConvertProc( ClientData \fIclientData\fR, - CONST char *\fIsrc\fR, + const char *\fIsrc\fR, int \fIsrcLen\fR, int \fIflags\fR, Tcl_EncodingState *\fIstatePtr\fR, diff --git a/doc/Environment.3 b/doc/Environment.3 index 68d725c..93df3c2 100644 --- a/doc/Environment.3 +++ b/doc/Environment.3 @@ -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: Environment.3,v 1.3 2004/10/07 14:44:32 dkf Exp $ +'\" RCS: @(#) $Id: Environment.3,v 1.4 2004/10/07 15:15:37 dkf Exp $ '\" .so man.macros .TH Tcl_PutEnv 3 "7.5" Tcl "Tcl Library Procedures" @@ -18,8 +18,8 @@ Tcl_PutEnv \- procedures to manipulate the environment int \fBTcl_PutEnv\fR(\fIstring\fR) .SH ARGUMENTS -.AS "CONST char" *string -.AP "CONST char" *string in +.AS "const char" *string +.AP "const char" *string in Info about environment variable in the form NAME=value. The string is in native format. .BE @@ -6,7 +6,7 @@ '\" 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.17 2004/10/07 14:44:32 dkf Exp $ +'\" RCS: @(#) $Id: Eval.3,v 1.18 2004/10/07 15:15:37 dkf Exp $ '\" .so man.macros .TH Tcl_Eval 3 8.1 Tcl "Tcl Library Procedures" @@ -53,7 +53,7 @@ A Tcl object containing the script to execute. .AP int flags in ORed combination of flag bits that specify additional options. \fBTCL_EVAL_GLOBAL\fR and \fBTCL_EVAL_DIRECT\fR are currently supported. -.AP "CONST char" *fileName in +.AP "const char" *fileName in Name of a file containing a Tcl script. .AP int objc in The number of objects in the array pointed to by \fIobjPtr\fR; @@ -65,7 +65,7 @@ value of a single word in the command to execute. The number of bytes in \fIscript\fR, not including any null terminating character. If \-1, then all characters up to the first null byte are used. -.AP "CONST char" *script in +.AP "const char" *script in Points to first byte of script to execute (null-terminated and UTF-8). .AP char *string in String forming part of a Tcl script. diff --git a/doc/ExprLong.3 b/doc/ExprLong.3 index 1c5b004..bc70595 100644 --- a/doc/ExprLong.3 +++ b/doc/ExprLong.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ExprLong.3,v 1.7 2004/10/07 14:44:32 dkf Exp $ +'\" RCS: @(#) $Id: ExprLong.3,v 1.8 2004/10/07 15:15:37 dkf Exp $ '\" .so man.macros .TH Tcl_ExprLong 3 7.0 Tcl "Tcl Library Procedures" @@ -32,7 +32,7 @@ int .AP Tcl_Interp *interp in Interpreter in whose context to evaluate \fIstring\fR or \fIobjPtr\fR. .VS 8.4 -.AP "CONST char" *string in +.AP "const char" *string in .VE Expression to be evaluated. .AP long *longPtr out diff --git a/doc/FileSystem.3 b/doc/FileSystem.3 index e874e8c..1781a34 100644 --- a/doc/FileSystem.3 +++ b/doc/FileSystem.3 @@ -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: FileSystem.3,v 1.49 2004/10/07 08:49:37 dkf Exp $ +'\" RCS: @(#) $Id: FileSystem.3,v 1.50 2004/10/07 15:15:37 dkf Exp $ '\" .so man.macros .TH Filesystem 3 8.4 Tcl "Tcl Library Procedures" @@ -84,7 +84,7 @@ int int \fBTcl_FSFileAttrsSet\fR(\fIinterp, int index, pathPtr, Tcl_Obj *objPtr\fR) .sp -CONST char** +const char** \fBTcl_FSFileAttrStrings\fR(\fIpathPtr, objPtrRef\fR) .sp int @@ -129,13 +129,13 @@ ClientData Tcl_Obj * \fBTcl_FSGetTranslatedPath\fR(\fIinterp, pathPtr\fR) .sp -CONST char * +const char * \fBTcl_FSGetTranslatedStringPath\fR(\fIinterp, pathPtr\fR) .sp Tcl_Obj* \fBTcl_FSNewNativePath\fR(\fIfsPtr, clientData\fR) .sp -CONST char * +const char * \fBTcl_FSGetNativePath\fR(\fIpathPtr\fR) .sp Tcl_Obj* @@ -158,10 +158,10 @@ rename operation. .AP Tcl_Obj *destPathPtr in As for \fIpathPtr\fR, but used for the destination filename for a copy or rename operation. -.AP "CONST char" *encodingName in +.AP "const char" *encodingName in The encoding of the data stored in the file identified by \fIpathPtr\fR and to be evaluted. -.AP "CONST char" *pattern in +.AP "const char" *pattern in Only files or directories matching this pattern will be returned. .AP Tcl_GlobTypeData *types in Only files or directories matching the type descriptions contained in @@ -198,9 +198,9 @@ write and execute permissions, respectively. F_OK just requests checking for the existence of the file. .AP Tcl_StatBuf *statPtr out The structure that contains the result of a stat or lstat operation. -.AP "CONST char" *sym1 in +.AP "const char" *sym1 in Name of a procedure to look up in the file's symbol table -.AP "CONST char" *sym2 in +.AP "const char" *sym2 in Name of a procedure to look up in the file's symbol table .AP Tcl_PackageInitProc **proc1Ptr out Filled with the init function for this code. @@ -214,7 +214,7 @@ Filled with the function to use to unload this piece of code. .AP utimbuf *tval in The access and modification times in this structure are read and used to set those values for a given file. -.AP "CONST char" *modeString in +.AP "const char" *modeString in Specifies how the file is to be accessed. May have any of the values allowed for the \fImode\fR argument to the Tcl \fBopen\fR command. .AP int permissions in @@ -226,7 +226,7 @@ If non-NULL, filled with the number of elements in the split path. The base path on to which to join the given elements. May be NULL. .AP int objc in The number of elements in \fIobjv\fR. -.AP "Tcl_Obj *CONST" objv[] in +.AP "Tcl_Obj *const" objv[] in The elements to join to the given base path. .BE @@ -701,7 +701,7 @@ longer be correct. The \fBTcl_Filesystem\fR structure contains the following fields: .CS typedef struct Tcl_Filesystem { - CONST char *\fItypeName\fR; + const char *\fItypeName\fR; int \fIstructureLength\fR; Tcl_FSVersion \fIversion\fR; Tcl_FSPathInFilesystemProc *\fIpathInFilesystemProc\fR; @@ -1064,7 +1064,7 @@ typedef int Tcl_FSMatchInDirectoryProc( Tcl_Interp* \fIinterp\fR, Tcl_Obj *\fIresultPtr\fR, Tcl_Obj *\fIpathPtr\fR, - CONST char *\fIpattern\fR, + const char *\fIpattern\fR, Tcl_GlobTypeData *\fItypes\fR); .CE .PP @@ -1192,7 +1192,7 @@ not implemented, there is no need to implement the \fBget\fR and \fBset\fR methods. .PP .CS -typedef CONST char** Tcl_FSFileAttrStringsProc( +typedef const char** Tcl_FSFileAttrStringsProc( Tcl_Obj *\fIpathPtr\fR, Tcl_Obj** \fIobjPtrRef\fR); .CE diff --git a/doc/FindExec.3 b/doc/FindExec.3 index d6519bf..10a3c72 100644 --- a/doc/FindExec.3 +++ b/doc/FindExec.3 @@ -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: FindExec.3,v 1.6 2004/10/07 14:44:32 dkf Exp $ +'\" RCS: @(#) $Id: FindExec.3,v 1.7 2004/10/07 15:15:38 dkf Exp $ '\" .so man.macros .TH Tcl_FindExecutable 3 8.1 Tcl "Tcl Library Procedures" @@ -18,7 +18,7 @@ Tcl_FindExecutable, Tcl_GetNameOfExecutable \- identify or return the name of th void \fBTcl_FindExecutable\fR(\fIargv0\fR) .sp -CONST char * +const char * \fBTcl_GetNameOfExecutable\fR() .SH ARGUMENTS .AS char *argv0 diff --git a/doc/GetHostName.3 b/doc/GetHostName.3 index 21e1364..37252dc 100644 --- a/doc/GetHostName.3 +++ b/doc/GetHostName.3 @@ -2,7 +2,7 @@ '\" Copyright (c) 1998-2000 by Scriptics Corporation. '\" All rights reserved. '\" -'\" RCS: @(#) $Id: GetHostName.3,v 1.3 2002/11/15 15:34:17 dkf Exp $ +'\" RCS: @(#) $Id: GetHostName.3,v 1.4 2004/10/07 15:15:38 dkf Exp $ '\" .so man.macros .TH Tcl_GetHostName 3 8.3 Tcl "Tcl Library Procedures" @@ -13,7 +13,7 @@ Tcl_GetHostName \- get the name of the local host .nf \fB#include <tcl.h>\fR .sp -CONST char * +const char * \fBTcl_GetHostName\fR() .BE diff --git a/doc/GetIndex.3 b/doc/GetIndex.3 index 7c4ea50..f54dd3c 100644 --- a/doc/GetIndex.3 +++ b/doc/GetIndex.3 @@ -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: GetIndex.3,v 1.14 2004/10/07 14:44:32 dkf Exp $ +'\" RCS: @(#) $Id: GetIndex.3,v 1.15 2004/10/07 15:15:38 dkf Exp $ '\" .so man.macros .TH Tcl_GetIndexFromObj 3 8.1 Tcl "Tcl Library Procedures" @@ -25,7 +25,7 @@ int msg, flags, indexPtr\fR) .VE .SH ARGUMENTS -.AS "CONST char" *structTablePtr in/out +.AS "const char" *structTablePtr in/out .AP Tcl_Interp *interp in Interpreter to use for error reporting; if NULL, then no message is provided on errors. @@ -33,10 +33,10 @@ provided on errors. The string value of this object is used to search through \fItablePtr\fR. The internal representation is modified to hold the index of the matching table entry. -.AP "CONST char" **tablePtr in +.AP "const char" **tablePtr in An array of null-terminated strings. The end of the array is marked by a NULL string pointer. -.AP "CONST VOID" *structTablePtr in +.AP "const void" *structTablePtr in An array of arbitrary type, typically some \fBstruct\fP type. The first member of the structure must be a null-terminated string. The size of the structure is given by \fIoffset\fP. @@ -45,7 +45,7 @@ The size of the structure is given by \fIoffset\fP. The offset to add to structTablePtr to get to the next entry. The end of the array is marked by a NULL string pointer. .VE -.AP "CONST char" *msg in +.AP "const char" *msg in Null-terminated string describing what is being looked up, such as \fBoption\fR. This string is included in error messages. .AP int flags in diff --git a/doc/GetInt.3 b/doc/GetInt.3 index a25fc42..bd1475e 100644 --- a/doc/GetInt.3 +++ b/doc/GetInt.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetInt.3,v 1.6 2004/10/07 14:44:32 dkf Exp $ +'\" RCS: @(#) $Id: GetInt.3,v 1.7 2004/10/07 15:15:38 dkf Exp $ '\" .so man.macros .TH Tcl_GetInt 3 "" Tcl "Tcl Library Procedures" @@ -28,7 +28,7 @@ int .AS Tcl_Interp *doublePtr out .AP Tcl_Interp *interp in Interpreter to use for error reporting. -.AP "CONST char" *string in +.AP "const char" *string in Textual value to be converted. .AP int *intPtr out Points to place to store integer value converted from \fIstring\fR. diff --git a/doc/GetOpnFl.3 b/doc/GetOpnFl.3 index 15ed812..e73f748 100644 --- a/doc/GetOpnFl.3 +++ b/doc/GetOpnFl.3 @@ -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: GetOpnFl.3,v 1.7 2004/10/07 14:44:32 dkf Exp $ +'\" RCS: @(#) $Id: GetOpnFl.3,v 1.8 2004/10/07 15:15:38 dkf Exp $ .so man.macros .TH Tcl_GetOpenFile 3 8.0 Tcl "Tcl Library Procedures" .BS @@ -21,7 +21,7 @@ int .AS Tcl_Interp checkUsage out .AP Tcl_Interp *interp in Tcl interpreter from which file handle is to be obtained. -.AP "CONST char" *string in +.AP "const char" *string in String identifying channel, such as \fBstdin\fR or \fBfile4\fR. .AP int write in Non-zero means the file will be used for writing, zero means it will @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: Hash.3,v 1.16 2004/10/07 14:44:32 dkf Exp $ +'\" RCS: @(#) $Id: Hash.3,v 1.17 2004/10/07 15:15:38 dkf Exp $ '\" .so man.macros .TH Tcl_Hash 3 "" Tcl "Tcl Library Procedures" @@ -46,7 +46,7 @@ Tcl_HashEntry * Tcl_HashEntry * \fBTcl_NextHashEntry\fR(\fIsearchPtr\fR) .sp -CONST char * +const char * \fBTcl_HashStats\fR(\fItablePtr\fR) .SH ARGUMENTS .AS Tcl_HashKeyType *searchPtr out @@ -60,7 +60,7 @@ Kind of keys to use for new hash table. Must be either \fBTCL_CUSTOM_PTR_KEYS\fR, or an integer value greater than 1. .AP Tcl_HashKeyType *typePtr in Address of structure which defines the behaviour of the hash table. -.AP "CONST char" *key in +.AP "const char" *key in Key to use for probe into table. Exact form depends on \fIkeyType\fR used to create table. .AP int *newPtr out @@ -273,8 +273,8 @@ The \fIhashKeyProc\fR member contains the address of a function called to calculate a hash value for the key. .CS typedef unsigned int (Tcl_HashKeyProc) ( - Tcl_HashTable *\fItablePtr\fR, - VOID *\fIkeyPtr\fR); + Tcl_HashTable *\fItablePtr\fR, + void *\fIkeyPtr\fR); .CE If this is NULL then \fIkeyPtr\fR is used and \fBTCL_HASH_KEY_RANDOMIZE_HASH\fR is assumed. @@ -282,8 +282,9 @@ If this is NULL then \fIkeyPtr\fR is used and The \fIcompareKeysProc\fR member contains the address of a function called to compare two keys. .CS -typedef int (Tcl_CompareHashKeysProc) (VOID *\fIkeyPtr\fR, - Tcl_HashEntry *\fIhPtr\fR); +typedef int (Tcl_CompareHashKeysProc) ( + void *\fIkeyPtr\fR, + Tcl_HashEntry *\fIhPtr\fR); .CE If this is NULL then the \fIkeyPtr\fR pointers are compared. If the keys don't match then the function returns 0, otherwise @@ -293,7 +294,8 @@ The \fIallocEntryProc\fR member contains the address of a function called to allocate space for an entry and initialize the key. .CS typedef Tcl_HashEntry *(Tcl_AllocHashEntryProc) ( - Tcl_HashTable *\fItablePtr\fR, VOID *\fIkeyPtr\fR); + Tcl_HashTable *\fItablePtr\fR, + void *\fIkeyPtr\fR); .CE If this is NULL then Tcl_Alloc is used to allocate enough space for a Tcl_HashEntry and the key pointer is assigned to key.oneWordValue. diff --git a/doc/InitStubs.3 b/doc/InitStubs.3 index 46fab2a..0c42814 100644 --- a/doc/InitStubs.3 +++ b/doc/InitStubs.3 @@ -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: InitStubs.3,v 1.10 2004/10/07 14:44:32 dkf Exp $ +'\" RCS: @(#) $Id: InitStubs.3,v 1.11 2004/10/07 15:15:38 dkf Exp $ '\" .so man.macros .TH Tcl_InitStubs 3 8.1 Tcl "Tcl Library Procedures" @@ -15,13 +15,13 @@ Tcl_InitStubs \- initialize the Tcl stubs mechanism .nf \fB#include <tcl.h>\fR .sp -CONST char * +const char * \fBTcl_InitStubs\fR(\fIinterp, version, exact\fR) .SH ARGUMENTS .AS Tcl_Interp *interp .AP Tcl_Interp *interp in Tcl interpreter handle. -.AP "CONST char" *version in +.AP "const char" *version in A version string consisting of one or more decimal numbers separated by dots. .AP int exact in diff --git a/doc/LinkVar.3 b/doc/LinkVar.3 index 2741685..7f5dfa0 100644 --- a/doc/LinkVar.3 +++ b/doc/LinkVar.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: LinkVar.3,v 1.8 2004/09/18 17:01:06 dkf Exp $ +'\" RCS: @(#) $Id: LinkVar.3,v 1.9 2004/10/07 15:15:38 dkf Exp $ '\" .so man.macros .TH Tcl_LinkVar 3 7.5 Tcl "Tcl Library Procedures" @@ -27,7 +27,7 @@ int .AP Tcl_Interp *interp in Interpreter that contains \fIvarName\fR. Also used by \fBTcl_LinkVar\fR to return error messages. -.AP "CONST char" *varName in +.AP "const char" *varName in Name of global variable. .AP char *addr in Address of C variable that is to be linked to \fIvarName\fR. diff --git a/doc/ListObj.3 b/doc/ListObj.3 index 98e7c3b..8e97f43 100644 --- a/doc/ListObj.3 +++ b/doc/ListObj.3 @@ -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: ListObj.3,v 1.6 2004/10/07 14:44:33 dkf Exp $ +'\" RCS: @(#) $Id: ListObj.3,v 1.7 2004/10/07 15:15:38 dkf Exp $ '\" .so man.macros .TH Tcl_ListObj 3 8.0 Tcl "Tcl Library Procedures" @@ -38,7 +38,7 @@ int int \fBTcl_ListObjReplace\fR(\fIinterp, listPtr, first, count, objc, objv\fR) .SH ARGUMENTS -.AS "Tcl_Obj *CONST" *elemListPtr in/out +.AS "Tcl_Obj *const" *elemListPtr in/out .AP Tcl_Interp *interp in If an error occurs while converting an object to be a list object, an error message is left in the interpreter's result object @@ -74,7 +74,7 @@ and \fBTcl_ListObjReplace\fR will insert into \fIlistPtr\fR. For \fBTcl_SetListObj\fR, the number of Tcl objects to insert into \fIobjPtr\fR. .VS -.AP "Tcl_Obj *CONST" objv[] in +.AP "Tcl_Obj *const" objv[] in An array of pointers to objects. \fBTcl_NewListObj\fR will insert these objects into a new list object and \fBTcl_ListObjReplace\fR will insert them into an existing \fIlistPtr\fR. diff --git a/doc/Namespace.3 b/doc/Namespace.3 index fb87eb9..5f61f2b 100644 --- a/doc/Namespace.3 +++ b/doc/Namespace.3 @@ -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: Namespace.3,v 1.6 2004/10/07 14:44:33 dkf Exp $ +'\" RCS: @(#) $Id: Namespace.3,v 1.7 2004/10/07 15:15:38 dkf Exp $ '\" '\" Note that some of these functions do not seem to belong, but they '\" were all introduced with the same TIP (#139) @@ -51,7 +51,7 @@ Tcl_Command .AP Tcl_Interp *interp in/out The interpreter in which the namespace exists and where name lookups are performed. Also where error result messages are written. -.AP "CONST char" *name in +.AP "const char" *name in The name of the namespace or command to be created or accessed. .AP ClientData clientData in A context pointer by the creator of the namespace. Not interpreted by @@ -65,7 +65,7 @@ The namespace to be manipulated, or NULL (for other than .AP Tcl_Obj *objPtr out A reference to an unshared object to which the function output will be written. -.AP "CONST char" *pattern in +.AP "const char" *pattern in The glob-style pattern (see \fBTcl_StringMatch\fR) that describes the commands to be imported or exported. .AP int resetListFirst in diff --git a/doc/Object.3 b/doc/Object.3 index 8c3d950..446b2f0 100644 --- a/doc/Object.3 +++ b/doc/Object.3 @@ -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: Object.3,v 1.9 2004/10/07 14:52:43 dkf Exp $ +'\" RCS: @(#) $Id: Object.3,v 1.10 2004/10/07 15:15:38 dkf Exp $ '\" .so man.macros .TH Tcl_Obj 3 8.1 Tcl "Tcl Library Procedures" @@ -120,10 +120,10 @@ typedef struct Tcl_Obj { union { long \fIlongValue\fR; double \fIdoubleValue\fR; - VOID *\fIotherValuePtr\fR; + void *\fIotherValuePtr\fR; struct { - VOID *\fIptr1\fR; - VOID *\fIptr2\fR; + void *\fIptr1\fR; + void *\fIptr2\fR; } \fItwoPtrValue\fR; } \fIinternalRep\fR; } Tcl_Obj; diff --git a/doc/ObjectType.3 b/doc/ObjectType.3 index 2354d0c..9a4a2f8 100644 --- a/doc/ObjectType.3 +++ b/doc/ObjectType.3 @@ -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: ObjectType.3,v 1.11 2004/10/07 14:52:43 dkf Exp $ +'\" RCS: @(#) $Id: ObjectType.3,v 1.12 2004/10/07 15:15:38 dkf Exp $ '\" .so man.macros .TH Tcl_ObjType 3 8.0 Tcl "Tcl Library Procedures" @@ -31,7 +31,7 @@ int Points to the structure containing information about the Tcl object type. This storage must live forever, typically by being statically allocated. -.AP "CONST char" *typeName in +.AP "const char" *typeName in The name of a Tcl object type that \fBTcl_GetObjType\fR should look up. .AP Tcl_Interp *interp in Interpreter to use for error reporting. diff --git a/doc/OpenFileChnl.3 b/doc/OpenFileChnl.3 index c3992bc..9de49d3 100644 --- a/doc/OpenFileChnl.3 +++ b/doc/OpenFileChnl.3 @@ -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: OpenFileChnl.3,v 1.27 2004/10/07 14:44:33 dkf Exp $ +'\" RCS: @(#) $Id: OpenFileChnl.3,v 1.28 2004/10/07 15:15:38 dkf Exp $ .so man.macros .TH Tcl_OpenFileChannel 3 8.3 Tcl "Tcl Library Procedures" .BS @@ -111,9 +111,9 @@ int .AS Tcl_ChannelType newClientProcPtr in/out .AP Tcl_Interp *interp in Used for error reporting and to look up a channel registered in it. -.AP "CONST char" *fileName in +.AP "const char" *fileName in The name of a local or network file. -.AP "CONST char" *mode in +.AP "const char" *mode in Specifies how the file is to be accessed. May have any of the values allowed for the \fImode\fR argument to the Tcl \fBopen\fR command. .AP int permissions in @@ -121,7 +121,7 @@ POSIX-style permission flags such as 0644. If a new file is created, these permissions will be set on the created file. .AP int argc in The number of elements in \fIargv\fR. -.AP "CONST char" **argv in +.AP "const char" **argv in Arguments for constructing a command pipeline. These values have the same meaning as the non-switch arguments to the Tcl \fBexec\fR command. .AP int flags in @@ -140,13 +140,13 @@ file descriptor, for Windows it is a HANDLE. .AP int readOrWrite in OR-ed combination of \fBTCL_READABLE\fR and \fBTCL_WRITABLE\fR to indicate what operations are valid on \fIhandle\fR. -.AP "CONST char" *channelName in +.AP "const char" *channelName in The name of the channel. .AP int *modePtr out Points at an integer variable that will receive an OR-ed combination of \fBTCL_READABLE\fR and \fBTCL_WRITABLE\fR denoting whether the channel is open for reading and writing. -.AP "CONST char" *pattern in +.AP "const char" *pattern in The pattern to match on, passed to Tcl_StringMatch, or NULL. .AP Tcl_Channel channel in A Tcl channel for input or output. Must have been the return value @@ -174,7 +174,7 @@ object. A pointer to a Tcl dynamic string in which to store the line read from the channel. Must have been initialized by the caller. The line read will be appended to any data already in the dynamic string. -.AP "CONST char" *input in +.AP "const char" *input in The input to add to a channel buffer. .AP int inputLen in Length of the input @@ -183,9 +183,9 @@ Flag indicating whether the input should be added to the end or beginning of the channel buffer. .AP Tcl_Obj *writeObjPtr in A pointer to a Tcl Object whose contents will be output to the channel. -.AP "CONST char" *charBuf in +.AP "const char" *charBuf in A buffer containing the characters to output to the channel. -.AP "CONST char" *byteBuf in +.AP "const char" *byteBuf in A buffer containing the bytes to output to the channel. .AP int bytesToWrite in The number of bytes to consume from \fIcharBuf\fR or \fIbyteBuf\fR and @@ -198,13 +198,13 @@ given by \fIseekMode\fR. May be either positive or negative. Relative to which point to seek; used with \fIoffset\fR to calculate the new access point for the channel. Legal values are \fBSEEK_SET\fR, \fBSEEK_CUR\fR, and \fBSEEK_END\fR. -.AP "CONST char" *optionName in +.AP "const char" *optionName in The name of an option applicable to this channel, such as \fB\-blocking\fR. May have any of the values accepted by the \fBfconfigure\fR command. .AP Tcl_DString *optionValue in Where to store the value of an option or a list of all options and their values. Must have been initialized by the caller. -.AP "CONST char" *newValue in +.AP "const char" *newValue in New value for the option given by \fIoptionName\fR. .BE diff --git a/doc/OpenTcp.3 b/doc/OpenTcp.3 index c6edda6..70f809b 100644 --- a/doc/OpenTcp.3 +++ b/doc/OpenTcp.3 @@ -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: OpenTcp.3,v 1.7 2004/10/07 14:52:43 dkf Exp $ +'\" RCS: @(#) $Id: OpenTcp.3,v 1.8 2004/10/07 15:15:42 dkf Exp $ .so man.macros .TH Tcl_OpenTcpClient 3 8.0 Tcl "Tcl Library Procedures" .BS @@ -31,12 +31,12 @@ Tcl interpreter to use for error reporting. If non-NULL and an error occurs, an error message is left in the interpreter's result. .AP int port in A port number to connect to as a client or to listen on as a server. -.AP "CONST char" *host in +.AP "const char" *host in A string specifying a host name or address for the remote end of the connection. .AP int myport in A port number for the client's end of the socket. If 0, a port number is allocated at random. -.AP "CONST char" *myaddr in +.AP "const char" *myaddr in A string specifying the host name or address for network interface to use for the local end of the connection. If NULL, a default interface is chosen. diff --git a/doc/Panic.3 b/doc/Panic.3 index fea0aee..edd8615 100644 --- a/doc/Panic.3 +++ b/doc/Panic.3 @@ -2,7 +2,7 @@ '\" 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.6 2004/10/07 14:52:43 dkf Exp $ +'\" RCS: @(#) $Id: Panic.3,v 1.7 2004/10/07 15:15:47 dkf Exp $ '\" .so man.macros .TH Tcl_Panic 3 8.4 Tcl "Tcl Library Procedures" @@ -25,7 +25,7 @@ void .sp .SH ARGUMENTS .AS Tcl_PanicProc *panicProc -.AP "CONST char*" format in +.AP "const char*" format in A printf-style format string. .AP "" arg in Arguments matching the format string. @@ -61,7 +61,7 @@ type \fBTcl_PanicProc\fR: .PP .CS typedef void Tcl_PanicProc( - CONST char *\fBformat\fR, + const char *\fBformat\fR, \fBarg\fR, \fBarg\fR,...); .CE .PP diff --git a/doc/ParseCmd.3 b/doc/ParseCmd.3 index 5c8d0a6..5f4edaf 100644 --- a/doc/ParseCmd.3 +++ b/doc/ParseCmd.3 @@ -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: ParseCmd.3,v 1.16 2004/10/07 14:52:43 dkf Exp $ +'\" RCS: @(#) $Id: ParseCmd.3,v 1.17 2004/10/07 15:15:47 dkf Exp $ '\" .so man.macros .TH Tcl_ParseCommand 3 8.3 Tcl "Tcl Library Procedures" @@ -30,7 +30,7 @@ int int \fBTcl_ParseVarName\fR(\fIinterp, string, numBytes, parsePtr, append\fR) .sp -CONST char * +const char * \fBTcl_ParseVar\fR(\fIinterp, string, termPtr\fR) .sp \fBTcl_FreeParse\fR(\fIusedParsePtr\fR) @@ -49,7 +49,7 @@ if NULL, then no error messages are left after errors. For \fBTcl_EvalTokens\fR and \fBTcl_EvalTokensStandard\fR, determines the context for evaluating the script and also is used for error reporting; must not be NULL. -.AP "CONST char" *string in +.AP "const char" *string in Pointer to first character in string to parse. .AP int numBytes in Number of bytes in \fIstring\fR, not including any terminating null @@ -71,7 +71,7 @@ Any previous information in this structure is ignored, unless \fIappend\fR is non-zero in a call to \fBTcl_ParseBraces\fR, \fBTcl_ParseQuotedString\fR, or \fBTcl_ParseVarName\fR. -.AP "CONST char" **termPtr out +.AP "const char" **termPtr out If not NULL, points to a location where \fBTcl_ParseBraces\fR, \fBTcl_ParseQuotedString\fR, and \fBTcl_ParseVar\fR will store a pointer to the character @@ -212,9 +212,9 @@ of \fBTcl_EvalTokens\fR is deprecated. return parse information in two data structures, Tcl_Parse and Tcl_Token: .CS typedef struct Tcl_Parse { - CONST char *\fIcommentStart\fR; + const char *\fIcommentStart\fR; int \fIcommentSize\fR; - CONST char *\fIcommandStart\fR; + const char *\fIcommandStart\fR; int \fIcommandSize\fR; int \fInumWords\fR; Tcl_Token *\fItokenPtr\fR; @@ -223,10 +223,10 @@ typedef struct Tcl_Parse { } Tcl_Parse; typedef struct Tcl_Token { - int \fItype\fR; - CONST char *\fIstart\fR; - int \fIsize\fR; - int \fInumComponents\fR; + int \fItype\fR; + const char *\fIstart\fR; + int \fIsize\fR; + int \fInumComponents\fR; } Tcl_Token; .CE .PP diff --git a/doc/PkgRequire.3 b/doc/PkgRequire.3 index 4259203..4cb939a 100644 --- a/doc/PkgRequire.3 +++ b/doc/PkgRequire.3 @@ -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: PkgRequire.3,v 1.8 2004/10/07 14:44:33 dkf Exp $ +'\" RCS: @(#) $Id: PkgRequire.3,v 1.9 2004/10/07 15:15:47 dkf Exp $ '\" .so man.macros .TH Tcl_PkgRequire 3 7.5 Tcl "Tcl Library Procedures" @@ -15,16 +15,16 @@ Tcl_PkgRequire, Tcl_PkgRequireEx, Tcl_PkgPresent, Tcl_PkgPresentEx, Tcl_PkgProvi .nf \fB#include <tcl.h>\fR .sp -CONST char * +const char * \fBTcl_PkgRequire\fR(\fIinterp, name, version, exact\fR) .sp -CONST char * +const char * \fBTcl_PkgRequireEx\fR(\fIinterp, name, version, exact, clientDataPtr\fR) .sp -CONST char * +const char * \fBTcl_PkgPresent\fR(\fIinterp, name, version, exact\fR) .sp -CONST char * +const char * \fBTcl_PkgPresentEx\fR(\fIinterp, name, version, exact, clientDataPtr\fR) .sp int @@ -36,9 +36,9 @@ int .AS ClientData clientDataPtr out .AP Tcl_Interp *interp in Interpreter where package is needed or available. -.AP "CONST char" *name in +.AP "const char" *name in Name of package. -.AP "CONST char" *version in +.AP "const char" *version in A version string consisting of one or more decimal numbers separated by dots. .AP int exact in diff --git a/doc/RecordEval.3 b/doc/RecordEval.3 index 3b169c4..68cdd9a 100644 --- a/doc/RecordEval.3 +++ b/doc/RecordEval.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: RecordEval.3,v 1.6 2004/10/07 14:44:33 dkf Exp $ +'\" RCS: @(#) $Id: RecordEval.3,v 1.7 2004/10/07 15:15:47 dkf Exp $ '\" .so man.macros .TH Tcl_RecordAndEval 3 7.4 Tcl "Tcl Library Procedures" @@ -22,7 +22,7 @@ int .AS Tcl_Interp *interp .AP Tcl_Interp *interp in Tcl interpreter in which to evaluate command. -.AP "CONST char" *cmd in +.AP "const char" *cmd in Command (or sequence of commands) to execute. .AP int flags in An OR'ed combination of flag bits. \fBTCL_NO_EVAL\fR means record the diff --git a/doc/RegConfig.3 b/doc/RegConfig.3 index 2ebaef9..908c2ec 100644 --- a/doc/RegConfig.3 +++ b/doc/RegConfig.3 @@ -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: RegConfig.3,v 1.5 2004/10/07 14:44:33 dkf Exp $ +'\" RCS: @(#) $Id: RegConfig.3,v 1.6 2004/10/07 15:15:47 dkf Exp $ .so man.macros .TH Tcl_RegisterConfig 3 8.4 Tcl "Tcl Library Procedures" .BS @@ -23,7 +23,7 @@ void .AP Tcl_Interp *interp in Refers to the interpreter the embedded configuration information is registered for. Must not be NULL. -.AP "CONST char" *pkgName in +.AP "const char" *pkgName in Contains the name of the package registering the embedded configuration as ASCII string. This means that this information is in UTF-8 too. Must not be NULL. @@ -32,7 +32,7 @@ Refers to an array of Tcl_Config entries containing the information embedded in the binary library. Must not be NULL. The end of the array is signaled by either a key identical to NULL, or a key referring to the empty string. -.AP "CONST char" *valEncoding in +.AP "const char" *valEncoding in Contains the name of the encoding used to store the configuration values as ASCII string. This means that this information is in UTF-8 too. Must not be NULL. @@ -103,10 +103,10 @@ Returns the configuration value associated with the specified The \fBTcl_Config\fR structure contains the following fields: .PP .CS - typedef struct Tcl_Config { - CONST char* key; - CONST char* value; - } Tcl_Config; +typedef struct Tcl_Config { + const char* key; + const char* value; +} Tcl_Config; .CE '\" No cross references yet. diff --git a/doc/RegExp.3 b/doc/RegExp.3 index 49e7b5a..8892a20 100644 --- a/doc/RegExp.3 +++ b/doc/RegExp.3 @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: RegExp.3,v 1.17 2004/10/07 14:52:43 dkf Exp $ +'\" RCS: @(#) $Id: RegExp.3,v 1.18 2004/10/07 15:15:47 dkf Exp $ '\" .so man.macros .TH Tcl_RegExpMatch 3 8.1 Tcl "Tcl Library Procedures" @@ -53,7 +53,7 @@ Refers to the object from which to get a regular expression. The compiled regular expression is cached in the object. .AP char *string in String to check for a match with a regular expression. -.AP "CONST char" *pattern in +.AP "const char" *pattern in String in the form of a regular expression pattern. .AP Tcl_RegExp regexp in Compiled regular expression. Must have been returned previously @@ -68,10 +68,10 @@ Specifies which range is desired: 0 means the range of the entire match, 1 or greater means the range that matched a parenthesized sub-expression. .VS 8.4 -.AP "CONST char" **startPtr out +.AP "const char" **startPtr out The address of the first character in the range is stored here, or NULL if there is no such range. -.AP "CONST char" **endPtr out +.AP "const char" **endPtr out The address of the character just after the last one in the range is stored here, or NULL if there is no such range. .VE 8.4 diff --git a/doc/SetErrno.3 b/doc/SetErrno.3 index 5c24454..133353e 100644 --- a/doc/SetErrno.3 +++ b/doc/SetErrno.3 @@ -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: SetErrno.3,v 1.6 2004/10/07 14:44:33 dkf Exp $ +'\" RCS: @(#) $Id: SetErrno.3,v 1.7 2004/10/07 15:15:48 dkf Exp $ .so man.macros .TH Tcl_SetErrno 3 8.3 Tcl "Tcl Library Procedures" .BS @@ -20,10 +20,10 @@ void int \fBTcl_GetErrno\fR() .sp -CONST char * +const char * \fBTcl_ErrnoId\fR() .sp -CONST char * +const char * \fBTcl_ErrnoMsg\fR(\fIerrorCode\fR) .sp .SH ARGUMENTS diff --git a/doc/SetResult.3 b/doc/SetResult.3 index 3ec367b..c43cb4c 100644 --- a/doc/SetResult.3 +++ b/doc/SetResult.3 @@ -5,7 +5,7 @@ '\" 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.10 2004/10/07 14:44:33 dkf Exp $ +'\" RCS: @(#) $Id: SetResult.3,v 1.11 2004/10/07 15:15:48 dkf Exp $ '\" .so man.macros .TH Tcl_SetResult 3 8.0 Tcl "Tcl Library Procedures" @@ -23,7 +23,7 @@ Tcl_Obj * .sp \fBTcl_SetResult\fR(\fIinterp, string, freeProc\fR) .sp -CONST char * +const char * \fBTcl_GetStringResult\fR(\fIinterp\fR) .sp \fBTcl_AppendResult\fR(\fIinterp, string, string, ... , \fB(char *) NULL\fR) diff --git a/doc/SetVar.3 b/doc/SetVar.3 index 36f1a47..465749c 100644 --- a/doc/SetVar.3 +++ b/doc/SetVar.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: SetVar.3,v 1.10 2004/09/18 17:01:06 dkf Exp $ +'\" RCS: @(#) $Id: SetVar.3,v 1.11 2004/10/07 15:15:48 dkf Exp $ '\" .so man.macros .TH Tcl_SetVar 3 8.1 Tcl "Tcl Library Procedures" @@ -21,10 +21,10 @@ Tcl_Obj * \fBTcl_SetVar2Ex\fR(\fIinterp, name1, name2, newValuePtr, flags\fR) .VE .sp -CONST char * +const char * \fBTcl_SetVar\fR(\fIinterp, varName, newValue, flags\fR) .sp -CONST char * +const char * \fBTcl_SetVar2\fR(\fIinterp, name1, name2, newValue, flags\fR) .sp Tcl_Obj * @@ -35,10 +35,10 @@ Tcl_Obj * \fBTcl_GetVar2Ex\fR(\fIinterp, name1, name2, flags\fR) .VE .sp -CONST char * +const char * \fBTcl_GetVar\fR(\fIinterp, varName, flags\fR) .sp -CONST char * +const char * \fBTcl_GetVar2\fR(\fIinterp, name1, name2, flags\fR) .sp Tcl_Obj * @@ -53,13 +53,13 @@ int .AS Tcl_Interp *newValuePtr .AP Tcl_Interp *interp in Interpreter containing variable. -.AP "CONST char" *name1 in +.AP "const char" *name1 in Contains the name of an array variable (if \fIname2\fR is non-NULL) or (if \fIname2\fR is NULL) either the name of a scalar variable or a complete name including both variable name and index. May include \fB::\fR namespace qualifiers to specify a variable in a particular namespace. -.AP "CONST char" *name2 in +.AP "const char" *name2 in If non-NULL, gives name of element within array; in this case \fIname1\fR must refer to an array variable. .AP Tcl_Obj *newValuePtr in @@ -69,13 +69,13 @@ Points to a Tcl object containing the new value for the variable. .AP int flags in OR-ed combination of bits providing additional information. See below for valid values. -.AP "CONST char" *varName in +.AP "const char" *varName in Name of variable. May include \fB::\fR namespace qualifiers to specify a variable in a particular namespace. May refer to a scalar variable or an element of an array. -.AP "CONST char" *newValue in +.AP "const char" *newValue in New value for variable, specified as a null-terminated string. A copy of this value is stored in the variable. .AP Tcl_Obj *part1Ptr in diff --git a/doc/Signal.3 b/doc/Signal.3 index cb6d040..a28a680 100644 --- a/doc/Signal.3 +++ b/doc/Signal.3 @@ -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: Signal.3,v 1.3 2004/10/07 14:44:33 dkf Exp $ +'\" RCS: @(#) $Id: Signal.3,v 1.4 2004/10/07 15:15:48 dkf Exp $ .so man.macros .TH Tcl_SignalId 3 8.3 Tcl "Tcl Library Procedures" .BS @@ -14,10 +14,10 @@ Tcl_SignalId, Tcl_SignalMsg \- Convert signal codes .nf \fB#include <tcl.h>\fR .sp -CONST char * +const char * \fBTcl_SignalId\fR(\fIsig\fR) .sp -CONST char * +const char * \fBTcl_SignalMsg\fR(\fIsig\fR) .sp .SH ARGUMENTS diff --git a/doc/SplitList.3 b/doc/SplitList.3 index 861e6f1..5726f86 100644 --- a/doc/SplitList.3 +++ b/doc/SplitList.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: SplitList.3,v 1.8 2004/10/07 14:44:34 dkf Exp $ +'\" RCS: @(#) $Id: SplitList.3,v 1.9 2004/10/07 15:15:48 dkf Exp $ '\" .so man.macros .TH Tcl_SplitList 3 8.0 Tcl "Tcl Library Procedures" @@ -34,7 +34,7 @@ int int \fBTcl_ConvertCountedElement\fR(\fIsrc, length, dst, flags\fR) .SH ARGUMENTS -.AS "CONST char * CONST" ***argvPtr out +.AS "const char *const" ***argvPtr out .AP Tcl_Interp *interp out Interpreter to use for error reporting. If NULL, then no error message is left. @@ -42,17 +42,17 @@ is left. Pointer to a string with proper list structure. .AP int *argcPtr out Filled in with number of elements in \fIlist\fR. -.AP "CONST char" ***argvPtr out +.AP "const char" ***argvPtr out \fI*argvPtr\fR will be filled in with the address of an array of pointers to the strings that are the extracted elements of \fIlist\fR. There will be \fI*argcPtr\fR valid entries in the array, followed by a NULL entry. .AP int argc in Number of elements in \fIargv\fR. -.AP "CONST char * CONST" *argv in +.AP "const char *const" *argv in Array of strings to merge together into a single list. Each string will become a separate element of the list. -.AP "CONST char" *src in +.AP "const char" *src in String that is to become an element of a list. .AP int *flagsPtr in Pointer to word to fill in with information about \fIsrc\fR. diff --git a/doc/SplitPath.3 b/doc/SplitPath.3 index 9964f3a..d7380de 100644 --- a/doc/SplitPath.3 +++ b/doc/SplitPath.3 @@ -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: SplitPath.3,v 1.8 2004/10/07 14:44:34 dkf Exp $ +'\" RCS: @(#) $Id: SplitPath.3,v 1.9 2004/10/07 15:15:48 dkf Exp $ '\" .so man.macros .TH Tcl_SplitPath 3 7.5 Tcl "Tcl Library Procedures" @@ -23,20 +23,20 @@ char * Tcl_PathType \fBTcl_GetPathType\fR(\fIpath\fR) .SH ARGUMENTS -.AS "CONST char * CONST" ***argvPtr in/out -.AP "CONST char" *path in +.AS "const char *const" ***argvPtr in/out +.AP "const char" *path in File path in a form appropriate for the current platform (see the \fBfilename\fR manual entry for acceptable forms for path names). .AP int *argcPtr out Filled in with number of path elements in \fIpath\fR. -.AP "CONST char" ***argvPtr out +.AP "const char" ***argvPtr out \fI*argvPtr\fR will be filled in with the address of an array of pointers to the strings that are the extracted elements of \fIpath\fR. There will be \fI*argcPtr\fR valid entries in the array, followed by a NULL entry. .AP int argc in Number of elements in \fIargv\fR. -.AP "CONST char * CONST" *argv in +.AP "const char *const" *argv in Array of path elements to merge together into a single path. .AP Tcl_DString *resultPtr in/out A pointer to an initialized \fBTcl_DString\fR to which the result of diff --git a/doc/StaticPkg.3 b/doc/StaticPkg.3 index 8625b5a..0947202 100644 --- a/doc/StaticPkg.3 +++ b/doc/StaticPkg.3 @@ -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: StaticPkg.3,v 1.5 2004/09/06 09:48:54 dkf Exp $ +'\" RCS: @(#) $Id: StaticPkg.3,v 1.6 2004/10/07 15:15:48 dkf Exp $ '\" .so man.macros .TH Tcl_StaticPackage 3 7.5 Tcl "Tcl Library Procedures" @@ -23,7 +23,7 @@ If not NULL, points to an interpreter into which the package has already been loaded (i.e., the caller has already invoked the appropriate initialization procedure). NULL means the package hasn't yet been incorporated into any interpreter. -.AP "CONST char" *pkgName in +.AP "const char" *pkgName in Name of the package; should be properly capitalized (first letter upper-case, all others lower-case). .AP Tcl_PackageInitProc *initProc in diff --git a/doc/StrMatch.3 b/doc/StrMatch.3 index 6b009da..630ac8c 100644 --- a/doc/StrMatch.3 +++ b/doc/StrMatch.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: StrMatch.3,v 1.5 2004/10/07 14:44:34 dkf Exp $ +'\" RCS: @(#) $Id: StrMatch.3,v 1.6 2004/10/07 15:15:48 dkf Exp $ '\" .so man.macros .TH Tcl_StringMatch 3 8.1 Tcl "Tcl Library Procedures" @@ -22,10 +22,10 @@ int int \fBTcl_StringCaseMatch\fR(\fIstring\fR, \fIpattern\fR, \fInocase\fR) .SH ARGUMENTS -.AS "CONST char" *pattern -.AP "CONST char" *string in +.AS "const char" *pattern +.AP "const char" *string in String to test. -.AP "CONST char" *pattern in +.AP "const char" *pattern in Pattern to match against string. May contain special characters from the set *?\e[]. .AP int nocase in diff --git a/doc/StringObj.3 b/doc/StringObj.3 index 86db898..b7ca7d0 100644 --- a/doc/StringObj.3 +++ b/doc/StringObj.3 @@ -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: StringObj.3,v 1.16 2004/03/23 09:01:00 dkf Exp $ +'\" RCS: @(#) $Id: StringObj.3,v 1.17 2004/10/07 15:15:48 dkf Exp $ '\" .so man.macros .TH Tcl_StringObj 3 8.1 Tcl "Tcl Library Procedures" @@ -72,8 +72,8 @@ int Tcl_Obj * \fBTcl_ConcatObj\fR(\fIobjc, objv\fR) .SH ARGUMENTS -.AS "CONST Tcl_UniChar" *appendObjPtr in/out -.AP "CONST char" *bytes in +.AS "const Tcl_UniChar" *appendObjPtr in/out +.AP "const char" *bytes in .VS 8.1 Points to the first byte of an array of UTF-8-encoded bytes used to set or append to a string object. @@ -87,7 +87,7 @@ the string is a collection of uninterpreted bytes.) The number of bytes to copy from \fIbytes\fR when initializing, setting, or appending to a string object. If negative, all bytes up to the first null are used. -.AP "CONST Tcl_UniChar" *unicode in +.AP "const Tcl_UniChar" *unicode in Points to the first byte of an array of Unicode characters used to set or append to a string object. This byte array may contain embedded null characters @@ -111,7 +111,7 @@ The object to append to \fIobjPtr\fR in \fBTcl_AppendObjToObj\fR. .AP int *lengthPtr out If non-NULL, the location where \fBTcl_GetStringFromObj\fR will store the length of an object's string representation. -.AP "CONST char" *string in +.AP "const 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 @@ -165,7 +165,7 @@ will be able to modify the string representation within the \fBTcl_UpdateStringProc\fR of their \fBTcl_ObjType\fR. Except for that limited purpose, the pointer returned by \fBTcl_GetStringFromObj\fR or \fBTcl_GetString\fR should be treated as read-only. It is -recommended that this pointer be assigned to a (CONST char *) variable. +recommended that this pointer be assigned to a (const char *) variable. Even in the limited situations where writing to this pointer is acceptable, one should take care to respect the copy-on-write semantics required by \fBTcl_Obj\fR's, with appropriate calls diff --git a/doc/TraceCmd.3 b/doc/TraceCmd.3 index d05cd34..10714a1 100644 --- a/doc/TraceCmd.3 +++ b/doc/TraceCmd.3 @@ -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. '\" -'\" CVS: @(#) $Id: TraceCmd.3,v 1.7 2004/10/07 14:52:43 dkf Exp $ +'\" CVS: @(#) $Id: TraceCmd.3,v 1.8 2004/10/07 15:15:48 dkf Exp $ '\" .so man.macros .TH Tcl_TraceCommand 3 7.4 Tcl "Tcl Library Procedures" @@ -27,7 +27,7 @@ void .AS Tcl_CommandTraceProc prevClientData .AP Tcl_Interp *interp in Interpreter containing the command. -.AP "CONST char" *cmdName in +.AP "const char" *cmdName in Name of command. .AP int flags in OR-ed collection of the values \fBTCL_TRACE_RENAME\fR and @@ -69,8 +69,8 @@ match the type \fBTcl_CommandTraceProc\fR: typedef void Tcl_CommandTraceProc( ClientData \fIclientData\fR, Tcl_Interp *\fIinterp\fR, - CONST char *\fIoldName\fR, - CONST char *\fInewName\fR, + const char *\fIoldName\fR, + const char *\fInewName\fR, int \fIflags\fR); .CE The \fIclientData\fR and \fIinterp\fR parameters will have the same diff --git a/doc/TraceVar.3 b/doc/TraceVar.3 index acf9b45..be4d994 100644 --- a/doc/TraceVar.3 +++ b/doc/TraceVar.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: TraceVar.3,v 1.11 2004/10/07 14:52:43 dkf Exp $ +'\" RCS: @(#) $Id: TraceVar.3,v 1.12 2004/10/07 15:15:48 dkf Exp $ '\" .so man.macros .TH Tcl_TraceVar 3 7.4 Tcl "Tcl Library Procedures" @@ -35,7 +35,7 @@ ClientData .AS Tcl_VarTraceProc prevClientData .AP Tcl_Interp *interp in Interpreter containing variable. -.AP "CONST char" *varName in +.AP "const char" *varName in Name of variable. May refer to a scalar variable, to an array variable with no index, or to an array variable with a parenthesized index. @@ -50,9 +50,9 @@ procedures. See below for more information. Procedure to invoke whenever one of the traced operations occurs. .AP ClientData clientData in Arbitrary one-word value to pass to \fIproc\fR. -.AP "CONST char" *name1 in +.AP "const char" *name1 in Name of scalar or array variable (without array index). -.AP "CONST char" *name2 in +.AP "const char" *name2 in For a trace on an element of an array, gives the index of the element. For traces on scalar variables or on whole arrays, is NULL. diff --git a/doc/Translate.3 b/doc/Translate.3 index 3f80f3a..f496e6f 100644 --- a/doc/Translate.3 +++ b/doc/Translate.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: Translate.3,v 1.8 2004/10/07 14:44:35 dkf Exp $ +'\" RCS: @(#) $Id: Translate.3,v 1.9 2004/10/07 15:15:48 dkf Exp $ '\" .so man.macros .TH Tcl_TranslateFileName 3 8.1 Tcl "Tcl Library Procedures" @@ -22,7 +22,7 @@ char * .AS Tcl_DString *bufferPtr in/out .AP Tcl_Interp *interp in Interpreter in which to report an error, if any. -.AP "CONST char" *name in +.AP "const char" *name in File name, which may start with a ``~''. .AP Tcl_DString *bufferPtr in/out If needed, this dynamic string is used to store the new file name. diff --git a/doc/UpVar.3 b/doc/UpVar.3 index 0c8beeb..56aba45 100644 --- a/doc/UpVar.3 +++ b/doc/UpVar.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: UpVar.3,v 1.9 2004/10/07 14:44:35 dkf Exp $ +'\" RCS: @(#) $Id: UpVar.3,v 1.10 2004/10/07 15:15:48 dkf Exp $ '\" .so man.macros .TH Tcl_UpVar 3 7.4 Tcl "Tcl Library Procedures" @@ -22,18 +22,18 @@ int int \fBTcl_UpVar2(\fIinterp, frameName, name1, name2, destName, flags\fB)\fR .SH ARGUMENTS -.AS "CONST char" *sourceName +.AS "const char" *sourceName .AP Tcl_Interp *interp in Interpreter containing variables; also used for error reporting. -.AP "CONST char" *frameName in +.AP "const char" *frameName in Identifies the stack frame containing source variable. May have any of the forms accepted by the \fBupvar\fR command, such as \fB#0\fR or \fB1\fR. -.AP "CONST char" *sourceName in +.AP "const char" *sourceName in Name of source variable, in the frame given by \fIframeName\fR. May refer to a scalar variable or to an array variable with a parenthesized index. -.AP "CONST char" *destName in +.AP "const char" *destName in Name of destination variable, which is to be linked to source variable so that references to \fIdestName\fR refer to the other variable. Must not currently exist except as @@ -42,10 +42,10 @@ an upvar-ed variable. Either \fBTCL_GLOBAL_ONLY\fR or 0; if non-zero, then \fIdestName\fR is a global variable; otherwise it is a local to the current procedure (or global if no procedure is active). -.AP "CONST char" *name1 in +.AP "const char" *name1 in First part of source variable's name (scalar name, or name of array without array index). -.AP "CONST char" *name2 in +.AP "const char" *name2 in If source variable is an element of an array, gives the index of the element. For scalar source variables, is NULL. .BE @@ -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: Utf.3,v 1.18 2004/10/07 14:44:35 dkf Exp $ +'\" RCS: @(#) $Id: Utf.3,v 1.19 2004/10/07 15:15:48 dkf Exp $ '\" .so man.macros .TH Utf 3 "8.1" Tcl "Tcl Library Procedures" @@ -58,16 +58,16 @@ int \fBTcl_NumUtfChars\fR(\fIsrc, len\fR) .VS 8.4 .sp -CONST char * +const char * \fBTcl_UtfFindFirst\fR(\fIsrc, ch\fR) .sp -CONST char * +const char * \fBTcl_UtfFindLast\fR(\fIsrc, ch\fR) .sp -CONST char * +const char * \fBTcl_UtfNext\fR(\fIsrc\fR) .sp -CONST char * +const char * \fBTcl_UtfPrev\fR(\fIsrc, start\fR) .VE 8.4 .sp @@ -75,14 +75,14 @@ Tcl_UniChar \fBTcl_UniCharAtIndex\fR(\fIsrc, index\fR) .VS 8.4 .sp -CONST char * +const char * \fBTcl_UtfAtIndex\fR(\fIsrc, index\fR) .VE 8.4 .sp int \fBTcl_UtfBackslash\fR(\fIsrc, readPtr, dst\fR) .SH ARGUMENTS -.AS "CONST Tcl_UniChar" *uniPattern in/out +.AS "const Tcl_UniChar" *uniPattern in/out .AP char *buf out Buffer in which the UTF-8 representation of the Tcl_UniChar is stored. At most \fBTCL_UTF_MAX\fR bytes are stored in the buffer. @@ -90,11 +90,11 @@ Buffer in which the UTF-8 representation of the Tcl_UniChar is stored. At most The Tcl_UniChar to be converted or examined. .AP Tcl_UniChar *chPtr out Filled with the Tcl_UniChar represented by the head of the UTF-8 string. -.AP "CONST char" *src in +.AP "const char" *src in Pointer to a UTF-8 string. -.AP "CONST Tcl_UniChar" *uniStr in +.AP "const Tcl_UniChar" *uniStr in A null-terminated Unicode string. -.AP "CONST Tcl_UniChar" *uniPattern in +.AP "const Tcl_UniChar" *uniPattern in A null-terminated Unicode string. .AP int len in The length of the UTF-8 string in bytes (not UTF-8 characters). If @@ -106,7 +106,7 @@ equal to 0. A pointer to a previously initialized \fBTcl_DString\fR. .AP "unsigned long" num in The number of characters to compare. -.AP "CONST char" *start in +.AP "const char" *start in Pointer to the beginning of a UTF-8 string. .AP int index in The index of a character (not byte) in the UTF-8 string. diff --git a/doc/WrongNumArgs.3 b/doc/WrongNumArgs.3 index 1113bc0..2a9adc2 100644 --- a/doc/WrongNumArgs.3 +++ b/doc/WrongNumArgs.3 @@ -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: WrongNumArgs.3,v 1.7 2004/10/07 14:44:35 dkf Exp $ +'\" RCS: @(#) $Id: WrongNumArgs.3,v 1.8 2004/10/07 15:15:48 dkf Exp $ '\" .so man.macros .TH Tcl_WrongNumArgs 3 8.0 Tcl "Tcl Library Procedures" @@ -17,16 +17,16 @@ Tcl_WrongNumArgs \- generate standard error message for wrong number of argument .sp \fBTcl_WrongNumArgs\fR(\fIinterp, objc, objv, message\fR) .SH ARGUMENTS -.AS "Tcl_Obj *CONST" *message +.AS "Tcl_Obj *const" *message .AP Tcl_Interp interp in Interpreter in which error will be reported: error message gets stored in its result object. .AP int objc in Number of leading arguments from \fIobjv\fR to include in error message. -.AP "Tcl_Obj *CONST" objv[] in +.AP "Tcl_Obj *const" objv[] in Arguments to command that had the wrong number of arguments. -.AP "CONST char" *message in +.AP "const char" *message in Additional error information to print after leading arguments from \fIobjv\fR. This typically gives the acceptable syntax of the command. This argument may be NULL. |