diff options
author | dgp <dgp@users.sourceforge.net> | 2002-01-25 20:40:54 (GMT) |
---|---|---|
committer | dgp <dgp@users.sourceforge.net> | 2002-01-25 20:40:54 (GMT) |
commit | 7bb89f954aeb2e32b07d01513217ab6930f80ccf (patch) | |
tree | 90cd60706107518bc582921a1eb262224b8dac22 /doc | |
parent | e987f887ebf5997e0c4461c254ec85e39a7b0b46 (diff) | |
download | tcl-7bb89f954aeb2e32b07d01513217ab6930f80ccf.zip tcl-7bb89f954aeb2e32b07d01513217ab6930f80ccf.tar.gz tcl-7bb89f954aeb2e32b07d01513217ab6930f80ccf.tar.bz2 |
* Updated interfaces of generic/tclEncoding, generic/tclFilename.c,
generic/tclIOUtil.c, generic/tclPipe.c, generic/tclResult.c,
generic/tclUtil.c, generic/tclVar.c and mac/tclMacResource.c according
to TIP 27. Tcl_TranslateFileName rewritten as wrapper around
VFS-aware version. Updated callers.
***POTENTIAL INCOMPATIBILITY***
Includes source incompatibilities: argv arguments of Tcl_Concat,
Tcl_JoinPath, Tcl_OpenCommandChannel, Tcl_Merge; argvPtr arguments of
Tcl_SplitList and Tcl_SplitPath.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Concat.3 | 4 | ||||
-rw-r--r-- | doc/Encoding.3 | 12 | ||||
-rw-r--r-- | doc/FileSystem.3 | 6 | ||||
-rw-r--r-- | doc/Macintosh.3 | 8 | ||||
-rw-r--r-- | doc/OpenFileChnl.3 | 4 | ||||
-rw-r--r-- | doc/SetResult.3 | 4 | ||||
-rw-r--r-- | doc/SetVar.3 | 12 | ||||
-rw-r--r-- | doc/SplitList.3 | 8 | ||||
-rw-r--r-- | doc/SplitPath.3 | 10 | ||||
-rw-r--r-- | doc/Translate.3 | 6 |
10 files changed, 37 insertions, 37 deletions
diff --git a/doc/Concat.3 b/doc/Concat.3 index 83c5c30..d67eca3 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.3 2001/09/24 21:10:32 dgp Exp $ +'\" RCS: @(#) $Id: Concat.3,v 1.4 2002/01/25 20:40:55 dgp Exp $ '\" .so man.macros .TH Tcl_Concat 3 7.5 Tcl "Tcl Library Procedures" @@ -21,7 +21,7 @@ char * .SH ARGUMENTS .AP int argc in Number of strings. -.AP "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/Encoding.3 b/doc/Encoding.3 index df219c3..65caab0 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.7 1999/10/13 00:32:05 hobbs Exp $ +'\" RCS: @(#) $Id: Encoding.3,v 1.8 2002/01/25 20:40:55 dgp Exp $ '\" .so man.macros .TH Tcl_GetEncoding 3 "8.1" Tcl "Tcl Library Procedures" @@ -21,14 +21,14 @@ Tcl_Encoding void \fBTcl_FreeEncoding\fR(\fIencoding\fR) .sp -char * +CONST char * \fBTcl_ExternalToUtfDString\fR(\fIencoding, src, srcLen, dstPtr\fR) .sp int \fBTcl_ExternalToUtf\fR(\fIinterp, encoding, src, srcLen, flags, statePtr, dst, dstLen, srcReadPtr, dstWrotePtr, dstCharsPtr\fR) .sp -char * +CONST char * \fBTcl_UtfToExternalDString\fR(\fIencoding, src, srcLen, dstPtr\fR) .sp int @@ -41,7 +41,7 @@ char * TCHAR * \fBTcl_WinUtfToTChar\fR(\fIsrc, srcLen, dstPtr\fR) .sp -char * +CONST char * \fBTcl_GetEncodingName\fR(\fIencoding\fR) .sp int @@ -53,7 +53,7 @@ void Tcl_Encoding \fBTcl_CreateEncoding\fR(\fItypePtr\fR) .sp -char * +CONST char * \fBTcl_GetDefaultEncodingDir\fR(\fIvoid\fR) .sp void @@ -124,7 +124,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 char *path in +.AP "CONST char" *path in A path to the location of the encoding file. .BE .SH INTRODUCTION diff --git a/doc/FileSystem.3 b/doc/FileSystem.3 index 405b40c..a56ea57 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.16 2002/01/17 04:37:32 dgp Exp $ +'\" RCS: @(#) $Id: FileSystem.3,v 1.17 2002/01/25 20:40:55 dgp Exp $ '\" .so man.macros .TH Filesystem 3 8.4 Tcl "Tcl Library Procedures" @@ -140,7 +140,7 @@ rename operation. .AP Tcl_Obj *destPathPtr in As for \fBpathPtr\fR, but used for the destination filename for a copy or rename operation. -.AP char *pattern in +.AP "CONST char" *pattern in Only files or directories matching this pattern will be returned by \fBTcl_FSMatchInDirectory\fR. .AP GlobTypeData *types in @@ -863,7 +863,7 @@ typedef int Tcl_FSMatchInDirectoryProc( Tcl_Interp* \fIinterp\fR, Tcl_Obj *\fIresult\fR, Tcl_Obj *\fIpathPtr\fR, - char *\fIpattern\fR, + CONST char *\fIpattern\fR, Tcl_GlobTypeData * \fItypes\fR); .CE .PP diff --git a/doc/Macintosh.3 b/doc/Macintosh.3 index 40e5b39..f8a7ee5 100644 --- a/doc/Macintosh.3 +++ b/doc/Macintosh.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: Macintosh.3,v 1.3 2001/05/03 23:57:10 hobbs Exp $ +'\" RCS: @(#) $Id: Macintosh.3,v 1.4 2002/01/25 20:40:55 dgp Exp $ '\" .so man.macros .TH Tcl_MacSetEventProc 3 "8.1" Tcl "Tcl Library Procedures" @@ -39,17 +39,17 @@ void .AP Tcl_Interp *interp in Interpreter to use for error reporting, or NULL if no error reporting is desired. -.AP char *resourceName in +.AP "CONST char" *resourceName in Name of TEXT resource to source, NULL if number should be used. .AP int resourceNumber in Resource id of source. -.AP char *fileName in +.AP "CONST char" *fileName in Name of file to process. NULL if application resource. .AP Handle resource in Handle to TEXT resource. .AP long resourceType in Type of resource to load. -.AP char *resFileRef in +.AP "CONST char" *resFileRef in Registered resource file reference, NULL if searching all open resource files. .AP int *releaseIt out Should we release this resource when done. diff --git a/doc/OpenFileChnl.3 b/doc/OpenFileChnl.3 index b6f25b9..ca81bc9 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.17 2002/01/15 21:19:06 dgp Exp $ +'\" RCS: @(#) $Id: OpenFileChnl.3,v 1.18 2002/01/25 20:40:55 dgp Exp $ .so man.macros .TH Tcl_OpenFileChannel 3 8.3 Tcl "Tcl Library Procedures" .BS @@ -127,7 +127,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 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 diff --git a/doc/SetResult.3 b/doc/SetResult.3 index fd23390..5a86be2 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.6 2000/07/24 00:03:02 jenglish Exp $ +'\" RCS: @(#) $Id: SetResult.3,v 1.7 2002/01/25 20:40:55 dgp 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 -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 bb07005..6f610c1 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.3 1999/04/16 00:46:33 stanton Exp $ +'\" RCS: @(#) $Id: SetVar.3,v 1.4 2002/01/25 20:40:55 dgp 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 -char * +CONST char * \fBTcl_SetVar\fR(\fIinterp, varName, newValue, flags\fR) .sp -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 -char * +CONST char * \fBTcl_GetVar\fR(\fIinterp, varName, flags\fR) .sp -char * +CONST char * \fBTcl_GetVar2\fR(\fIinterp, name1, name2, flags\fR) .sp Tcl_Obj * @@ -78,7 +78,7 @@ an array. If the name references an element of an array, then the name must be in writable memory: Tcl will make temporary modifications to it while looking up the name. -.AP 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/SplitList.3 b/doc/SplitList.3 index 0548606..c046af5 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.5 2001/09/24 21:10:32 dgp Exp $ +'\" RCS: @(#) $Id: SplitList.3,v 1.6 2002/01/25 20:40:55 dgp 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 Tcl_Interp ***argvPtr +.AS "CONST char * CONST" ***argvPtr .AP Tcl_Interp *interp out Interpreter to use for error reporting. If NULL, then no error message is left. @@ -42,14 +42,14 @@ is left. Pointer to a string with proper list structure. .AP int *argcPtr out Filled in with number of elements in \fIlist\fR. -.AP 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 "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 diff --git a/doc/SplitPath.3 b/doc/SplitPath.3 index 165df09..9013dd0 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.4 2001/09/27 00:19:57 dgp Exp $ +'\" RCS: @(#) $Id: SplitPath.3,v 1.5 2002/01/25 20:40:55 dgp Exp $ '\" .so man.macros .TH Tcl_SplitPath 3 7.5 Tcl "Tcl Library Procedures" @@ -17,26 +17,26 @@ Tcl_SplitPath, Tcl_JoinPath, Tcl_GetPathType \- manipulate platform-dependent fi .sp \fBTcl_SplitPath\fR(\fIpath, argcPtr, argvPtr\fR) .sp -char * +CONST char * \fBTcl_JoinPath\fR(\fIargc, argv, resultPtr\fR) .sp Tcl_PathType \fBTcl_GetPathType\fR(\fIpath\fR) .SH ARGUMENTS .AS Tcl_DString ***argvPtr -.AP "CONST char" *path in +.AP "CONST char * CONST" *argvPtr 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 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 char **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/Translate.3 b/doc/Translate.3 index d405be6..ff4a989 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.4 2000/04/14 23:01:54 hobbs Exp $ +'\" RCS: @(#) $Id: Translate.3,v 1.5 2002/01/25 20:40:55 dgp Exp $ '\" .so man.macros .TH Tcl_TranslateFileName 3 8.1 Tcl "Tcl Library Procedures" @@ -16,13 +16,13 @@ Tcl_TranslateFileName \- convert file name to native form and replace tilde with .nf \fB#include <tcl.h>\fR .sp -char * +CONST char * \fBTcl_TranslateFileName\fR(\fIinterp\fR, \fIname\fR, \fIbufferPtr\fR) .SH ARGUMENTS .AS Tcl_DString *bufferPtr .AP Tcl_Interp *interp in Interpreter in which to report an error, if any. -.AP 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. |