Make Tcl_AppendResult() non-deprecated again. [Patch 1041072]

Also change string to stringPtr to avoid potential future C++ problems.

3 files changed, 53 insertions, 110 deletions

diff --git a/ChangeLog b/ChangeLog
index 4249bc0..ddf202c 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,12 @@
+2004-10-06  Donal K. Fellows  <donal.k.fellows@man.ac.uk>
+
+	* doc/SetResult.3: Made Tcl_AppendResult non-deprecated; better
+	that people use it than most of the common alternatives!
+	* generic/tclResult.c (Tcl_AppendResultVA): Make this work better
+	with Tcl_Objs. [Patch 1041072]
+	(Tcl_SetResult, Tcl_AppendElement): Change string to stringPtr to
+	avoid C++ keywords.
+
 2004-10-05  Don Porter  <dgp@users.sourceforge.net>
 
 	* generic/tclBasic.c (TclObjInvoke): More simplification of the
diff --git a/doc/SetResult.3 b/doc/SetResult.3
index db1a5dc..cf7f623 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.8 2004/09/06 09:44:57 dkf Exp $
+'\" RCS: @(#) $Id: SetResult.3,v 1.9 2004/10/05 23:21:27 dkf Exp $
 '\" 
 .so man.macros
 .TH Tcl_SetResult 3 8.0 Tcl "Tcl Library Procedures"
@@ -116,14 +116,6 @@ and the result is left as a empty string.
 \fBTcl_ResetResult\fR also clears the error state managed by
 \fBTcl_AddErrorInfo\fR, \fBTcl_AddObjErrorInfo\fR,
 and \fBTcl_SetErrorCode\fR.
-
-.SH "OLD STRING PROCEDURES"
-.PP
-Use of the following procedures is deprecated
-since they manipulate the Tcl result as a string.
-Procedures such as \fBTcl_SetObjResult\fR
-that manipulate the result as an object
-can be significantly more efficient.
 .PP
 \fBTcl_AppendResult\fR makes it easy to build up Tcl results in pieces.
 It takes each of its \fIstring\fR arguments and appends them in order
@@ -137,13 +129,22 @@ of the result are produced.
 \fBTcl_AppendResult\fR takes care of all the
 storage management issues associated with managing \fIinterp\fR's
 result, such as allocating a larger result area if necessary.
-It also converts the current interpreter result from an object
-to a string, if necessary, before appending the argument strings.
+It also manages conversion to and from the \fIresult\fR field of the
+\fIinterp\fR so as to handle backward-compatability with old-style
+extensions.
 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.
+
+.SH "OLD STRING PROCEDURES"
+.PP
+Use of the following procedures (is deprecated
+since they manipulate the Tcl result as a string.
+Procedures such as \fBTcl_SetObjResult\fR
+that manipulate the result as an object
+can be significantly more efficient.
 .PP
 \fBTcl_AppendElement\fR is similar to \fBTcl_AppendResult\fR in
 that it allows results to be built up in pieces.
diff --git a/generic/tclResult.c b/generic/tclResult.c
index 2bd52dd..e15efce 100644
--- a/generic/tclResult.c
+++ b/generic/tclResult.c
@@ -8,7 +8,7 @@
  * See the file "license.terms" for information on usage and redistribution
  * of this file, and for a DISCLAIMER OF ALL WARRANTIES.
  *
- * RCS: @(#) $Id: tclResult.c,v 1.12 2004/10/05 18:14:28 dgp Exp $
+ * RCS: @(#) $Id: tclResult.c,v 1.13 2004/10/05 23:21:26 dkf Exp $
  */
 
 #include "tclInt.h"
@@ -224,10 +224,10 @@ Tcl_DiscardResult(statePtr)
  */
 
 void
-Tcl_SetResult(interp, string, freeProc)
+Tcl_SetResult(interp, stringPtr, freeProc)
     Tcl_Interp *interp;		/* Interpreter with which to associate the
 				 * return value. */
-    register char *string;	/* Value to be returned.  If NULL, the
+    register char *stringPtr;	/* Value to be returned.  If NULL, the
 				 * result is set to an empty string. */
     Tcl_FreeProc *freeProc;	/* Gives information about the string:
 				 * TCL_STATIC, TCL_VOLATILE, or the address
@@ -238,12 +238,12 @@ Tcl_SetResult(interp, string, freeProc)
     register Tcl_FreeProc *oldFreeProc = iPtr->freeProc;
     char *oldResult = iPtr->result;
 
-    if (string == NULL) {
+    if (stringPtr == NULL) {
 	iPtr->resultSpace[0] = 0;
 	iPtr->result = iPtr->resultSpace;
 	iPtr->freeProc = 0;
     } else if (freeProc == TCL_VOLATILE) {
-	length = strlen(string);
+	length = strlen(stringPtr);
 	if (length > TCL_RESULT_SIZE) {
 	    iPtr->result = (char *) ckalloc((unsigned) length+1);
 	    iPtr->freeProc = TCL_DYNAMIC;
@@ -251,9 +251,9 @@ Tcl_SetResult(interp, string, freeProc)
 	    iPtr->result = iPtr->resultSpace;
 	    iPtr->freeProc = 0;
 	}
-	strcpy(iPtr->result, string);
+	strcpy(iPtr->result, stringPtr);
     } else {
-	iPtr->result = string;
+	iPtr->result = stringPtr;
 	iPtr->freeProc = freeProc;
     }
 
@@ -428,7 +428,7 @@ Tcl_GetObjResult(interp)
  *
  * Tcl_AppendResultVA --
  *
- *	Append a variable number of strings onto the interpreter's string
+ *	Append a variable number of strings onto the interpreter's
  *	result.
  *
  * Results:
@@ -436,102 +436,34 @@ Tcl_GetObjResult(interp)
  *
  * Side effects:
  *	The result of the interpreter given by the first argument is
- *	extended by the strings in the va_list (up to a terminating NULL
- *	argument).
+ *	extended by the strings in the va_list (up to a terminating
+ *	NULL argument).
  *
- *	If the string result is empty, the object result is moved to the
- *	string result, then the object result is reset.
+ *	If the string result is non-empty, the object result forced to
+ *	be a duplicate of it first. There will be a string result
+ *	afterwards.
  *
  *----------------------------------------------------------------------
  */
 
 void
-Tcl_AppendResultVA (interp, argList)
+Tcl_AppendResultVA(interp, argList)
     Tcl_Interp *interp;		/* Interpreter with which to associate the
 				 * return value. */
     va_list argList;		/* Variable argument list. */
 {
-#define STATIC_LIST_SIZE 16
-    Interp *iPtr = (Interp *) interp;
-    char *string, *static_list[STATIC_LIST_SIZE];
-    char **args = static_list;
-    int nargs_space = STATIC_LIST_SIZE;
-    int nargs, newSpace, i;
+    Tcl_Obj *objPtr = Tcl_GetObjResult(interp);
 
-    /*
-     * If the string result is empty, move the object result to the
-     * string result, then reset the object result.
-     */
-
-    if (*(iPtr->result) == 0) {
-	Tcl_SetResult((Tcl_Interp *) iPtr,
-	        TclGetString(Tcl_GetObjResult((Tcl_Interp *) iPtr)),
-	        TCL_VOLATILE);
+    if (Tcl_IsShared(objPtr)) {
+	objPtr = Tcl_DuplicateObj(objPtr);
     }
-    
+    Tcl_AppendStringsToObjVA(objPtr, argList);
+    Tcl_SetObjResult(interp, objPtr);
     /*
-     * Scan through all the arguments to see how much space is needed
-     * and save pointers to the arguments in the args array,
-     * reallocating as necessary.
+     * Ensure that the interp->result is legal so old Tcl 7.* code
+     * still works. There's still embarrasingly much of it about...
      */
-
-    nargs = 0;
-    newSpace = 0;
-    while (1) {
- 	string = va_arg(argList, char *);
-	if (string == NULL) {
-	    break;
-	}
- 	if (nargs >= nargs_space) {
- 	    /* 
- 	     * Expand the args buffer
- 	     */
- 	    nargs_space += STATIC_LIST_SIZE;
- 	    if (args == static_list) {
- 	    	args = (void *)ckalloc(nargs_space * sizeof(char *));
- 		for (i = 0; i < nargs; ++i) {
- 		    args[i] = static_list[i];
- 		}
- 	    } else {
- 		args = (void *)ckrealloc((void *)args,
-			nargs_space * sizeof(char *));
- 	    }
- 	}
-  	newSpace += strlen(string);
-	args[nargs++] = string;
-    }
-
-    /*
-     * If the append buffer isn't already setup and large enough to hold
-     * the new data, set it up.
-     */
-
-    if ((iPtr->result != iPtr->appendResult)
-	    || (iPtr->appendResult[iPtr->appendUsed] != 0)
-	    || ((newSpace + iPtr->appendUsed) >= iPtr->appendAvl)) {
-       SetupAppendBuffer(iPtr, newSpace);
-    }
-
-    /*
-     * Now go through all the argument strings again, copying them into the
-     * buffer.
-     */
-
-    for (i = 0; i < nargs; ++i) {
- 	string = args[i];
-  	strcpy(iPtr->appendResult + iPtr->appendUsed, string);
-  	iPtr->appendUsed += strlen(string);
-    }
- 
-    /*
-     * If we had to allocate a buffer from the heap, 
-     * free it now.
-     */
- 
-    if (args != static_list) {
-     	ckfree((void *)args);
-    }
-#undef STATIC_LIST_SIZE
+    (void) Tcl_GetStringResult(interp);
 }
 
 /*
@@ -539,7 +471,7 @@ Tcl_AppendResultVA (interp, argList)
  *
  * Tcl_AppendResult --
  *
- *	Append a variable number of strings onto the interpreter's string
+ *	Append a variable number of strings onto the interpreter's
  *	result.
  *
  * Results:
@@ -547,11 +479,12 @@ Tcl_AppendResultVA (interp, argList)
  *
  * Side effects:
  *	The result of the interpreter given by the first argument is
- *	extended by the strings given by the second and following arguments
- *	(up to a terminating NULL argument).
+ *	extended by the strings given by the second and following
+ *	arguments (up to a terminating NULL argument).
  *
- *	If the string result is empty, the object result is moved to the
- *	string result, then the object result is reset.
+ *	If the string result is non-empty, the object result forced to
+ *	be a duplicate of it first. There will be a string result
+ *	afterwards.
  *
  *----------------------------------------------------------------------
  */
@@ -591,10 +524,10 @@ Tcl_AppendResult TCL_VARARGS_DEF(Tcl_Interp *,arg1)
  */
 
 void
-Tcl_AppendElement(interp, string)
+Tcl_AppendElement(interp, stringPtr)
     Tcl_Interp *interp;		/* Interpreter whose result is to be
 				 * extended. */
-    CONST char *string;		/* String to convert to list element and
+    CONST char *stringPtr;	/* String to convert to list element and
 				 * add to result. */
 {
     Interp *iPtr = (Interp *) interp;
@@ -617,7 +550,7 @@ Tcl_AppendElement(interp, string)
      * needed to accommodate the list element.
      */
 
-    size = Tcl_ScanElement(string, &flags) + 1;
+    size = Tcl_ScanElement(stringPtr, &flags) + 1;
     if ((iPtr->result != iPtr->appendResult)
 	    || (iPtr->appendResult[iPtr->appendUsed] != 0)
 	    || ((size + iPtr->appendUsed) >= iPtr->appendAvl)) {
@@ -641,7 +574,7 @@ Tcl_AppendElement(interp, string)
 	 */
 	flags |= TCL_DONT_QUOTE_HASH;
     }
-    iPtr->appendUsed += Tcl_ConvertElement(string, dst, flags);
+    iPtr->appendUsed += Tcl_ConvertElement(stringPtr, dst, flags);
 }
 
 /*