shared/tcl_base/tclcmdah.c

/* $Header: /cvsroot/esrg/sfesrg/esrgpcpj/shared/tcl_base/tclcmdah.c,v 1.1.1.1 2001/06/13 04:34:24 dtashley Exp $ */

/* 
 * tclCmdAH.c --
 *
 *      This file contains the top-level command routines for most of
 *      the Tcl built-in commands whose names begin with the letters
 *      A to H.
 *
 * Copyright (c) 1987-1993 The Regents of the University of California.
 * Copyright (c) 1994-1997 Sun Microsystems, Inc.
 *
 * See the file "license.terms" for information on usage and redistribution
 * of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 *
 * RCS: @(#) $Id: tclcmdah.c,v 1.1.1.1 2001/06/13 04:34:24 dtashley Exp $
 */

#include "tclInt.h"
#include "tclPort.h"
#include <locale.h>

typedef int (StatProc)_ANSI_ARGS_((CONST char *path, struct stat *buf));

/*
 * Prototypes for local procedures defined in this file:
 */

static int              CheckAccess _ANSI_ARGS_((Tcl_Interp *interp,
                            Tcl_Obj *objPtr, int mode));
static int              GetStatBuf _ANSI_ARGS_((Tcl_Interp *interp,
                            Tcl_Obj *objPtr, StatProc *statProc,
                            struct stat *statPtr));
static char *           GetTypeFromMode _ANSI_ARGS_((int mode));
static int              SplitPath _ANSI_ARGS_((Tcl_Interp *interp,
                            Tcl_Obj *objPtr, int *argcPtr, char ***argvPtr));
static int              StoreStatData _ANSI_ARGS_((Tcl_Interp *interp,
                            char *varName, struct stat *statPtr));
static char **          StringifyObjects _ANSI_ARGS_((int objc,
                            Tcl_Obj *CONST objv[]));

/*
 *----------------------------------------------------------------------
 *
 * Tcl_BreakObjCmd --
 *
 *      This procedure is invoked to process the "break" Tcl command.
 *      See the user documentation for details on what it does.
 *
 *      With the bytecode compiler, this procedure is only called when
 *      a command name is computed at runtime, and is "break" or the name
 *      to which "break" was renamed: e.g., "set z break; $z"
 *
 * Results:
 *      A standard Tcl result.
 *
 * Side effects:
 *      See the user documentation.
 *
 *----------------------------------------------------------------------
 */

        /* ARGSUSED */
int
Tcl_BreakObjCmd(dummy, interp, objc, objv)
    ClientData dummy;                   /* Not used. */
    Tcl_Interp *interp;                 /* Current interpreter. */
    int objc;                           /* Number of arguments. */
    Tcl_Obj *CONST objv[];              /* Argument objects. */
{
    if (objc != 1) {
        Tcl_WrongNumArgs(interp, 1, objv, NULL);
        return TCL_ERROR;
    }
    return TCL_BREAK;
}

/*
 *----------------------------------------------------------------------
 *
 * Tcl_CaseObjCmd --
 *
 *      This procedure is invoked to process the "case" Tcl command.
 *      See the user documentation for details on what it does.
 *
 * Results:
 *      A standard Tcl object result.
 *
 * Side effects:
 *      See the user documentation.
 *
 *----------------------------------------------------------------------
 */

        /* ARGSUSED */
int
Tcl_CaseObjCmd(dummy, interp, objc, objv)
    ClientData dummy;           /* Not used. */
    Tcl_Interp *interp;         /* Current interpreter. */
    int objc;                   /* Number of arguments. */
    Tcl_Obj *CONST objv[];      /* Argument objects. */
{
    register int i;
    int body, result;
    char *string, *arg;
    int caseObjc;
    Tcl_Obj *CONST *caseObjv;
    Tcl_Obj *armPtr;

    if (objc < 3) {
        Tcl_WrongNumArgs(interp, 1, objv,
                "string ?in? patList body ... ?default body?");
        return TCL_ERROR;
    }

    string = Tcl_GetString(objv[1]);
    body = -1;

    arg = Tcl_GetString(objv[2]);
    if (strcmp(arg, "in") == 0) {
        i = 3;
    } else {
        i = 2;
    }
    caseObjc = objc - i;
    caseObjv = objv + i;

    /*
     * If all of the pattern/command pairs are lumped into a single
     * argument, split them out again.
     */

    if (caseObjc == 1) {
        Tcl_Obj **newObjv;
        
        Tcl_ListObjGetElements(interp, caseObjv[0], &caseObjc, &newObjv);
        caseObjv = newObjv;
    }

    for (i = 0;  i < caseObjc;  i += 2) {
        int patObjc, j;
        char **patObjv;
        char *pat;
        unsigned char *p;

        if (i == (caseObjc - 1)) {
            Tcl_ResetResult(interp);
            Tcl_AppendToObj(Tcl_GetObjResult(interp),
                    "extra case pattern with no body", -1);
            return TCL_ERROR;
        }

        /*
         * Check for special case of single pattern (no list) with
         * no backslash sequences.
         */

        pat = Tcl_GetString(caseObjv[i]);
        for (p = (unsigned char *) pat; *p != '\0'; p++) {
            if (isspace(*p) || (*p == '\\')) {  /* INTL: ISO space, UCHAR */
                break;
            }
        }
        if (*p == '\0') {
            if ((*pat == 'd') && (strcmp(pat, "default") == 0)) {
                body = i + 1;
            }
            if (Tcl_StringMatch(string, pat)) {
                body = i + 1;
                goto match;
            }
            continue;
        }


        /*
         * Break up pattern lists, then check each of the patterns
         * in the list.
         */

        result = Tcl_SplitList(interp, pat, &patObjc, &patObjv);
        if (result != TCL_OK) {
            return result;
        }
        for (j = 0; j < patObjc; j++) {
            if (Tcl_StringMatch(string, patObjv[j])) {
                body = i + 1;
                break;
            }
        }
        ckfree((char *) patObjv);
        if (j < patObjc) {
            break;
        }
    }

    match:
    if (body != -1) {
        armPtr = caseObjv[body - 1];
        result = Tcl_EvalObjEx(interp, caseObjv[body], 0);
        if (result == TCL_ERROR) {
            char msg[100 + TCL_INTEGER_SPACE];
            
            arg = Tcl_GetString(armPtr);
            sprintf(msg,
                    "\n    (\"%.50s\" arm line %d)", arg,
                    interp->errorLine);
            Tcl_AddObjErrorInfo(interp, msg, -1);
        }
        return result;
    }

    /*
     * Nothing matched: return nothing.
     */

    return TCL_OK;
}

/*
 *----------------------------------------------------------------------
 *
 * Tcl_CatchObjCmd --
 *
 *      This object-based procedure is invoked to process the "catch" Tcl 
 *      command. See the user documentation for details on what it does.
 *
 * Results:
 *      A standard Tcl object result.
 *
 * Side effects:
 *      See the user documentation.
 *
 *----------------------------------------------------------------------
 */

        /* ARGSUSED */
int
Tcl_CatchObjCmd(dummy, interp, objc, objv)
    ClientData dummy;           /* Not used. */
    Tcl_Interp *interp;         /* Current interpreter. */
    int objc;                   /* Number of arguments. */
    Tcl_Obj *CONST objv[];      /* Argument objects. */
{
    Tcl_Obj *varNamePtr = NULL;
    int result;

    if ((objc != 2) && (objc != 3)) {
        Tcl_WrongNumArgs(interp, 1, objv, "command ?varName?");
        return TCL_ERROR;
    }

    /*
     * Save a pointer to the variable name object, if any, in case the
     * Tcl_EvalObj reallocates the bytecode interpreter's evaluation
     * stack rendering objv invalid.
     */
    
    if (objc == 3) {
        varNamePtr = objv[2];
    }

    result = Tcl_EvalObjEx(interp, objv[1], 0);
    
    if (objc == 3) {
        if (Tcl_ObjSetVar2(interp, varNamePtr, NULL,
                Tcl_GetObjResult(interp), 0) == NULL) {
            Tcl_ResetResult(interp);
            Tcl_AppendToObj(Tcl_GetObjResult(interp),  
                    "couldn't save command result in variable", -1);
            return TCL_ERROR;
        }
    }

    /*
     * Set the interpreter's object result to an integer object holding the
     * integer Tcl_EvalObj result. Note that we don't bother generating a
     * string representation. We reset the interpreter's object result
     * to an unshared empty object and then set it to be an integer object.
     */

    Tcl_ResetResult(interp);
    Tcl_SetIntObj(Tcl_GetObjResult(interp), result);
    return TCL_OK;
}

/*
 *----------------------------------------------------------------------
 *
 * Tcl_CdObjCmd --
 *
 *      This procedure is invoked to process the "cd" Tcl command.
 *      See the user documentation for details on what it does.
 *
 * Results:
 *      A standard Tcl result.
 *
 * Side effects:
 *      See the user documentation.
 *
 *----------------------------------------------------------------------
 */

        /* ARGSUSED */
int
Tcl_CdObjCmd(dummy, interp, objc, objv)
    ClientData dummy;           /* Not used. */
    Tcl_Interp *interp;         /* Current interpreter. */
    int objc;                   /* Number of arguments. */
    Tcl_Obj *CONST objv[];      /* Argument objects. */
{
    char *dirName;
    Tcl_DString ds;
    int result;

    if (objc > 2) {
        Tcl_WrongNumArgs(interp, 1, objv, "?dirName?");
        return TCL_ERROR;
    }

    if (objc == 2) {
        dirName = Tcl_GetString(objv[1]);
    } else {
        dirName = "~";
    }
    if (Tcl_TranslateFileName(interp, dirName, &ds) == NULL) {
        return TCL_ERROR;
    }

    result = Tcl_Chdir(Tcl_DStringValue(&ds));
    Tcl_DStringFree(&ds);

    if (result != 0) {
        Tcl_AppendResult(interp, "couldn't change working directory to \"",
                dirName, "\": ", Tcl_PosixError(interp), (char *) NULL);
        return TCL_ERROR;
    }
    return TCL_OK;
}

/*
 *----------------------------------------------------------------------
 *
 * Tcl_ConcatObjCmd --
 *
 *      This object-based procedure is invoked to process the "concat" Tcl
 *      command. See the user documentation for details on what it does.
 *
 * Results:
 *      A standard Tcl object result.
 *
 * Side effects:
 *      See the user documentation.
 *
 *----------------------------------------------------------------------
 */

        /* ARGSUSED */
int
Tcl_ConcatObjCmd(dummy, interp, objc, objv)
    ClientData dummy;           /* Not used. */
    Tcl_Interp *interp;         /* Current interpreter. */
    int objc;                   /* Number of arguments. */
    Tcl_Obj *CONST objv[];      /* Argument objects. */
{
    if (objc >= 2) {
        Tcl_SetObjResult(interp, Tcl_ConcatObj(objc-1, objv+1));
    }
    return TCL_OK;
}

/*
 *----------------------------------------------------------------------
 *
 * Tcl_ContinueObjCmd -
 *
 *      This procedure is invoked to process the "continue" Tcl command.
 *      See the user documentation for details on what it does.
 *
 *      With the bytecode compiler, this procedure is only called when
 *      a command name is computed at runtime, and is "continue" or the name
 *      to which "continue" was renamed: e.g., "set z continue; $z"
 *
 * Results:
 *      A standard Tcl result.
 *
 * Side effects:
 *      See the user documentation.
 *
 *----------------------------------------------------------------------
 */

        /* ARGSUSED */
int
Tcl_ContinueObjCmd(dummy, interp, objc, objv)
    ClientData dummy;                   /* Not used. */
    Tcl_Interp *interp;                 /* Current interpreter. */
    int objc;                           /* Number of arguments. */
    Tcl_Obj *CONST objv[];              /* Argument objects. */
{
    if (objc != 1) {
        Tcl_WrongNumArgs(interp, 1, objv, NULL);
        return TCL_ERROR;
    }
    return TCL_CONTINUE;
}

/*
 *----------------------------------------------------------------------
 *
 * Tcl_EncodingObjCmd --
 *
 *      This command manipulates encodings.
 *
 * Results:
 *      A standard Tcl result.
 *
 * Side effects:
 *      See the user documentation.
 *
 *----------------------------------------------------------------------
 */

int
Tcl_EncodingObjCmd(dummy, interp, objc, objv)
    ClientData dummy;           /* Not used. */
    Tcl_Interp *interp;         /* Current interpreter. */
    int objc;                   /* Number of arguments. */
    Tcl_Obj *CONST objv[];      /* Argument objects. */
{
    int index, length;
    Tcl_Encoding encoding;
    char *string;
    Tcl_DString ds;
    Tcl_Obj *resultPtr;

    static char *optionStrings[] = {
        "convertfrom", "convertto", "names", "system",
        NULL
    };
    enum options {
        ENC_CONVERTFROM, ENC_CONVERTTO, ENC_NAMES, ENC_SYSTEM
    };

    if (objc < 2) {
        Tcl_WrongNumArgs(interp, 1, objv, "option ?arg ...?");
        return TCL_ERROR;
    }
    if (Tcl_GetIndexFromObj(interp, objv[1], optionStrings, "option", 0,
            &index) != TCL_OK) {
        return TCL_ERROR;
    }

    switch ((enum options) index) {
        case ENC_CONVERTTO:
        case ENC_CONVERTFROM: {
            char *name;
            Tcl_Obj *data;
            if (objc == 3) {
                name = NULL;
                data = objv[2];
            } else if (objc == 4) {
                name = Tcl_GetString(objv[2]);
                data = objv[3];
            } else {
                Tcl_WrongNumArgs(interp, 2, objv, "?encoding? data");
                return TCL_ERROR;
            }
            
            encoding = Tcl_GetEncoding(interp, name);
            if (!encoding) {
                return TCL_ERROR;
            }

            if ((enum options) index == ENC_CONVERTFROM) {
                /*
                 * Treat the string as binary data.
                 */

                string = (char *) Tcl_GetByteArrayFromObj(data, &length);
                Tcl_ExternalToUtfDString(encoding, string, length, &ds);

                /*
                 * Note that we cannot use Tcl_DStringResult here because
                 * it will truncate the string at the first null byte.
                 */

                Tcl_SetStringObj(Tcl_GetObjResult(interp),
                        Tcl_DStringValue(&ds), Tcl_DStringLength(&ds));
                Tcl_DStringFree(&ds);
            } else {
                /*
                 * Store the result as binary data.
                 */

                string = Tcl_GetStringFromObj(data, &length);
                Tcl_UtfToExternalDString(encoding, string, length, &ds);
                resultPtr = Tcl_GetObjResult(interp);
                Tcl_SetByteArrayObj(resultPtr, 
                        (unsigned char *) Tcl_DStringValue(&ds),
                        Tcl_DStringLength(&ds));
                Tcl_DStringFree(&ds);
            }

            Tcl_FreeEncoding(encoding);
            break;
        }
        case ENC_NAMES: {
            if (objc > 2) {
                Tcl_WrongNumArgs(interp, 2, objv, NULL);
                return TCL_ERROR;
            }
            Tcl_GetEncodingNames(interp);
            break;
        }
        case ENC_SYSTEM: {
            if (objc > 3) {
                Tcl_WrongNumArgs(interp, 2, objv, "?encoding?");
                return TCL_ERROR;
            }
            if (objc == 2) {
                Tcl_SetResult(interp, Tcl_GetEncodingName(NULL), TCL_STATIC);
            } else {
                return Tcl_SetSystemEncoding(interp,
                        Tcl_GetStringFromObj(objv[2], NULL));
            }
            break;
        }
    }
    return TCL_OK;
}

/*
 *----------------------------------------------------------------------
 *
 * Tcl_ErrorObjCmd --
 *
 *      This procedure is invoked to process the "error" Tcl command.
 *      See the user documentation for details on what it does.
 *
 * Results:
 *      A standard Tcl object result.
 *
 * Side effects:
 *      See the user documentation.
 *
 *----------------------------------------------------------------------
 */

        /* ARGSUSED */
int
Tcl_ErrorObjCmd(dummy, interp, objc, objv)
    ClientData dummy;           /* Not used. */
    Tcl_Interp *interp;         /* Current interpreter. */
    int objc;                   /* Number of arguments. */
    Tcl_Obj *CONST objv[];      /* Argument objects. */
{
    Interp *iPtr = (Interp *) interp;
    char *info;
    int infoLen;

    if ((objc < 2) || (objc > 4)) {
        Tcl_WrongNumArgs(interp, 1, objv, "message ?errorInfo? ?errorCode?");
        return TCL_ERROR;
    }
    
    if (objc >= 3) {            /* process the optional info argument */
        info = Tcl_GetStringFromObj(objv[2], &infoLen);
        if (*info != 0) {
            Tcl_AddObjErrorInfo(interp, info, infoLen);
            iPtr->flags |= ERR_ALREADY_LOGGED;
        }
    }
    
    if (objc == 4) {
        Tcl_SetVar2Ex(interp, "errorCode", NULL, objv[3], TCL_GLOBAL_ONLY);
        iPtr->flags |= ERROR_CODE_SET;
    }
    
    Tcl_SetObjResult(interp, objv[1]);
    return TCL_ERROR;
}

/*
 *----------------------------------------------------------------------
 *
 * Tcl_EvalObjCmd --
 *
 *      This object-based procedure is invoked to process the "eval" Tcl 
 *      command. See the user documentation for details on what it does.
 *
 * Results:
 *      A standard Tcl object result.
 *
 * Side effects:
 *      See the user documentation.
 *
 *----------------------------------------------------------------------
 */

        /* ARGSUSED */
int
Tcl_EvalObjCmd(dummy, interp, objc, objv)
    ClientData dummy;           /* Not used. */
    Tcl_Interp *interp;         /* Current interpreter. */
    int objc;                   /* Number of arguments. */
    Tcl_Obj *CONST objv[];      /* Argument objects. */
{
    int result;
    register Tcl_Obj *objPtr;

    if (objc < 2) {
        Tcl_WrongNumArgs(interp, 1, objv, "arg ?arg ...?");
        return TCL_ERROR;
    }
    
    if (objc == 2) {
        result = Tcl_EvalObjEx(interp, objv[1], TCL_EVAL_DIRECT);
    } else {
        /*
         * More than one argument: concatenate them together with spaces
         * between, then evaluate the result.  Tcl_EvalObjEx will delete
         * the object when it decrements its refcount after eval'ing it.
         */
        objPtr = Tcl_ConcatObj(objc-1, objv+1);
        result = Tcl_EvalObjEx(interp, objPtr, TCL_EVAL_DIRECT);
    }
    if (result == TCL_ERROR) {
        char msg[32 + TCL_INTEGER_SPACE];

        sprintf(msg, "\n    (\"eval\" body line %d)", interp->errorLine);
        Tcl_AddObjErrorInfo(interp, msg, -1);
    }
    return result;
}

/*
 *----------------------------------------------------------------------
 *
 * Tcl_ExitObjCmd --
 *
 *      This procedure is invoked to process the "exit" Tcl command.
 *      See the user documentation for details on what it does.
 *
 * Results:
 *      A standard Tcl object result.
 *
 * Side effects:
 *      See the user documentation.
 *
 *----------------------------------------------------------------------
 */

        /* ARGSUSED */
int
Tcl_ExitObjCmd(dummy, interp, objc, objv)
    ClientData dummy;           /* Not used. */
    Tcl_Interp *interp;         /* Current interpreter. */
    int objc;                   /* Number of arguments. */
    Tcl_Obj *CONST objv[];      /* Argument objects. */
{
    int value;

    if ((objc != 1) && (objc != 2)) {
        Tcl_WrongNumArgs(interp, 1, objv, "?returnCode?");
        return TCL_ERROR;
    }
    
    if (objc == 1) {
        value = 0;
    } else if (Tcl_GetIntFromObj(interp, objv[1], &value) != TCL_OK) {
        return TCL_ERROR;
    }
    Tcl_Exit(value);
    /*NOTREACHED*/
    return TCL_OK;                      /* Better not ever reach this! */
}

/*
 *----------------------------------------------------------------------
 *
 * Tcl_ExprObjCmd --
 *
 *      This object-based procedure is invoked to process the "expr" Tcl
 *      command. See the user documentation for details on what it does.
 *
 *      With the bytecode compiler, this procedure is called in two
 *      circumstances: 1) to execute expr commands that are too complicated
 *      or too unsafe to try compiling directly into an inline sequence of
 *      instructions, and 2) to execute commands where the command name is
 *      computed at runtime and is "expr" or the name to which "expr" was
 *      renamed (e.g., "set z expr; $z 2+3")
 *
 * Results:
 *      A standard Tcl object result.
 *
 * Side effects:
 *      See the user documentation.
 *
 *----------------------------------------------------------------------
 */

        /* ARGSUSED */
int
Tcl_ExprObjCmd(dummy, interp, objc, objv)
    ClientData dummy;           /* Not used. */
    Tcl_Interp *interp;         /* Current interpreter. */
    int objc;                   /* Number of arguments. */
    Tcl_Obj *CONST objv[];      /* Argument objects. */
{        
    register Tcl_Obj *objPtr;
    Tcl_Obj *resultPtr;
    register char *bytes;
    int length, i, result;

    if (objc < 2) {
        Tcl_WrongNumArgs(interp, 1, objv, "arg ?arg ...?");
        return TCL_ERROR;
    }

    if (objc == 2) {
        result = Tcl_ExprObj(interp, objv[1], &resultPtr);
        if (result == TCL_OK) {
            Tcl_SetObjResult(interp, resultPtr);
            Tcl_DecrRefCount(resultPtr);  /* done with the result object */
        }
        return result;
    }

    /*
     * Create a new object holding the concatenated argument strings.
     */

    bytes = Tcl_GetStringFromObj(objv[1], &length);
    objPtr = Tcl_NewStringObj(bytes, length);
    Tcl_IncrRefCount(objPtr);
    for (i = 2;  i < objc;  i++) {
        Tcl_AppendToObj(objPtr, " ", 1);
        bytes = Tcl_GetStringFromObj(objv[i], &length);
        Tcl_AppendToObj(objPtr, bytes, length);
    }

    /*
     * Evaluate the concatenated string object.
     */

    result = Tcl_ExprObj(interp, objPtr, &resultPtr);
    if (result == TCL_OK) {
        Tcl_SetObjResult(interp, resultPtr);
        Tcl_DecrRefCount(resultPtr);  /* done with the result object */
    }

    /*
     * Free allocated resources.
     */
    
    Tcl_DecrRefCount(objPtr);
    return result;
}

/*
 *----------------------------------------------------------------------
 *
 * Tcl_FileObjCmd --
 *
 *      This procedure is invoked to process the "file" Tcl command.
 *      See the user documentation for details on what it does.
 *      PLEASE NOTE THAT THIS FAILS WITH FILENAMES AND PATHS WITH
 *      EMBEDDED NULLS, WHICH COULD THEORETICALLY HAPPEN ON A MAC.
 *
 * Results:
 *      A standard Tcl result.
 *
 * Side effects:
 *      See the user documentation.
 *
 *----------------------------------------------------------------------
 */

        /* ARGSUSED */
int
Tcl_FileObjCmd(dummy, interp, objc, objv)
    ClientData dummy;           /* Not used. */
    Tcl_Interp *interp;         /* Current interpreter. */
    int objc;                   /* Number of arguments. */
    Tcl_Obj *CONST objv[];      /* Argument objects. */
{
    Tcl_Obj *resultPtr;
    int index;

/*
 * This list of constants should match the fileOption string array below.
 */

    static char *fileOptions[] = {
        "atime",        "attributes",   "channels",     "copy",
        "delete",
        "dirname",      "executable",   "exists",       "extension",
        "isdirectory",  "isfile",       "join",         "lstat",
        "mtime",        "mkdir",        "nativename",   "owned",
        "pathtype",     "readable",     "readlink",     "rename",
        "rootname",     "size",         "split",        "stat",
        "tail",         "type",         "volumes",      "writable",
        (char *) NULL
    };
    enum options {
        FILE_ATIME,     FILE_ATTRIBUTES, FILE_CHANNELS, FILE_COPY,
        FILE_DELETE,
        FILE_DIRNAME,   FILE_EXECUTABLE, FILE_EXISTS,   FILE_EXTENSION,
        FILE_ISDIRECTORY, FILE_ISFILE,  FILE_JOIN,      FILE_LSTAT,
        FILE_MTIME,     FILE_MKDIR,     FILE_NATIVENAME, FILE_OWNED,
        FILE_PATHTYPE,  FILE_READABLE,  FILE_READLINK,  FILE_RENAME,
        FILE_ROOTNAME,  FILE_SIZE,      FILE_SPLIT,     FILE_STAT,
        FILE_TAIL,      FILE_TYPE,      FILE_VOLUMES,   FILE_WRITABLE
    };

    if (objc < 2) {
        Tcl_WrongNumArgs(interp, 1, objv, "option ?arg ...?");
        return TCL_ERROR;
    }
    if (Tcl_GetIndexFromObj(interp, objv[1], fileOptions, "option", 0,
            &index) != TCL_OK) {
        return TCL_ERROR;
    }

    resultPtr = Tcl_GetObjResult(interp);
    switch ((enum options) index) {
        case FILE_ATIME: {
            struct stat buf;
            char *fileName;
            struct utimbuf tval;

            if ((objc < 3) || (objc > 4)) {
                Tcl_WrongNumArgs(interp, 2, objv, "name ?time?");
                return TCL_ERROR;
            }
            if (GetStatBuf(interp, objv[2], TclStat, &buf) != TCL_OK) {
                return TCL_ERROR;
            }
            if (objc == 4) {
                if (Tcl_GetLongFromObj(interp, objv[3],
                        (long*)(&buf.st_atime)) != TCL_OK) {
                    return TCL_ERROR;
                }
                tval.actime = buf.st_atime;
                tval.modtime = buf.st_mtime;
                fileName = Tcl_GetString(objv[2]);
                if (utime(fileName, &tval) != 0) {
                    Tcl_AppendStringsToObj(resultPtr,
                            "could not set access time for file \"",
                            fileName, "\": ",
                            Tcl_PosixError(interp), (char *) NULL);
                    return TCL_ERROR;
                }
                /*
                 * Do another stat to ensure that the we return the
                 * new recognized atime - hopefully the same as the
                 * one we sent in.  However, fs's like FAT don't
                 * even know what atime is.
                 */
                if (GetStatBuf(interp, objv[2], TclStat, &buf) != TCL_OK) {
                    return TCL_ERROR;
                }
            }
            Tcl_SetLongObj(resultPtr, (long) buf.st_atime);
            return TCL_OK;
        }
        case FILE_ATTRIBUTES: {
            return TclFileAttrsCmd(interp, objc, objv);
        }
        case FILE_CHANNELS: {
            if ((objc < 2) || (objc > 3)) {
                Tcl_WrongNumArgs(interp, 2, objv, "?pattern?");
                return TCL_ERROR;
            }
            return Tcl_GetChannelNamesEx(interp,
                    ((objc == 2) ? NULL : Tcl_GetString(objv[2])));
        }
        case FILE_COPY: {
            int result;
            char **argv;

            argv = StringifyObjects(objc, objv);
            result = TclFileCopyCmd(interp, objc, argv);
            ckfree((char *) argv);
            return result;
        }           
        case FILE_DELETE: {
            int result;
            char **argv;

            argv = StringifyObjects(objc, objv);
            result = TclFileDeleteCmd(interp, objc, argv);
            ckfree((char *) argv);
            return result;
        }
        case FILE_DIRNAME: {
            int argc;
            char **argv;

            if (objc != 3) {
                goto only3Args;
            }
            if (SplitPath(interp, objv[2], &argc, &argv) != TCL_OK) {
                return TCL_ERROR;
            }

            /*
             * Return all but the last component.  If there is only one
             * component, return it if the path was non-relative, otherwise
             * return the current directory.
             */

            if (argc > 1) {
                Tcl_DString ds;

                Tcl_DStringInit(&ds);
                Tcl_JoinPath(argc - 1, argv, &ds);
                Tcl_SetStringObj(resultPtr, Tcl_DStringValue(&ds),
                        Tcl_DStringLength(&ds));
                Tcl_DStringFree(&ds);
            } else if ((argc == 0)
                    || (Tcl_GetPathType(argv[0]) == TCL_PATH_RELATIVE)) {
                Tcl_SetStringObj(resultPtr,
                        ((tclPlatform == TCL_PLATFORM_MAC) ? ":" : "."), 1);
            } else {
                Tcl_SetStringObj(resultPtr, argv[0], -1);
            }
            ckfree((char *) argv);
            return TCL_OK;
        }
        case FILE_EXECUTABLE: {
            if (objc != 3) {
                goto only3Args;
            }
            return CheckAccess(interp, objv[2], X_OK);
        }
        case FILE_EXISTS: {
            if (objc != 3) {
                goto only3Args;
            }
            return CheckAccess(interp, objv[2], F_OK);
        }
        case FILE_EXTENSION: {
            char *fileName, *extension;
            if (objc != 3) {
                goto only3Args;
            }
            fileName = Tcl_GetString(objv[2]);
            extension = TclGetExtension(fileName);
            if (extension != NULL) {
                Tcl_SetStringObj(resultPtr, extension, -1);
            }
            return TCL_OK;
        }
        case FILE_ISDIRECTORY: {
            int value;
            struct stat buf;

            if (objc != 3) {
                goto only3Args;
            }
            value = 0;
            if (GetStatBuf(NULL, objv[2], TclStat, &buf) == TCL_OK) {
                value = S_ISDIR(buf.st_mode);
            }
            Tcl_SetBooleanObj(resultPtr, value);
            return TCL_OK;
        }
        case FILE_ISFILE: {
            int value;
            struct stat buf;
            
            if (objc != 3) {
                goto only3Args;
            }
            value = 0;
            if (GetStatBuf(NULL, objv[2], TclStat, &buf) == TCL_OK) {
                value = S_ISREG(buf.st_mode);
            }
            Tcl_SetBooleanObj(resultPtr, value);
            return TCL_OK;
        }
        case FILE_JOIN: {
            char **argv;
            Tcl_DString ds;

            if (objc < 3) {
                Tcl_WrongNumArgs(interp, 2, objv, "name ?name ...?");
                return TCL_ERROR;
            }
            argv = StringifyObjects(objc - 2, objv + 2);
            Tcl_DStringInit(&ds);
            Tcl_JoinPath(objc - 2, argv, &ds);
            Tcl_SetStringObj(resultPtr, Tcl_DStringValue(&ds),
                    Tcl_DStringLength(&ds));
            Tcl_DStringFree(&ds);
            ckfree((char *) argv);
            return TCL_OK;
        }
        case FILE_LSTAT: {
            char *varName;
            struct stat buf;

            if (objc != 4) {
                Tcl_WrongNumArgs(interp, 2, objv, "name varName");
                return TCL_ERROR;
            }
            if (GetStatBuf(interp, objv[2], TclpLstat, &buf) != TCL_OK) {
                return TCL_ERROR;
            }
            varName = Tcl_GetString(objv[3]);
            return StoreStatData(interp, varName, &buf);
        }
        case FILE_MTIME: {
            struct stat buf;
            char *fileName;
            struct utimbuf tval;

            if ((objc < 3) || (objc > 4)) {
                Tcl_WrongNumArgs(interp, 2, objv, "name ?time?");
                return TCL_ERROR;
            }
            if (GetStatBuf(interp, objv[2], TclStat, &buf) != TCL_OK) {
                return TCL_ERROR;
            }
            if (objc == 4) {
                if (Tcl_GetLongFromObj(interp, objv[3],
                        (long*)(&buf.st_mtime)) != TCL_OK) {
                    return TCL_ERROR;
                }
                tval.actime = buf.st_atime;
                tval.modtime = buf.st_mtime;
                fileName = Tcl_GetString(objv[2]);
                if (utime(fileName, &tval) != 0) {
                    Tcl_AppendStringsToObj(resultPtr,
                            "could not set modification time for file \"",
                            fileName, "\": ",
                            Tcl_PosixError(interp), (char *) NULL);
                    return TCL_ERROR;
                }
                /*
                 * Do another stat to ensure that the we return the
                 * new recognized atime - hopefully the same as the
                 * one we sent in.  However, fs's like FAT don't
                 * even know what atime is.
                 */
                if (GetStatBuf(interp, objv[2], TclStat, &buf) != TCL_OK) {
                    return TCL_ERROR;
                }
            }
            Tcl_SetLongObj(resultPtr, (long) buf.st_mtime);
            return TCL_OK;
        }
        case FILE_MKDIR: {
            char **argv;
            int result;

            if (objc < 3) {
                Tcl_WrongNumArgs(interp, 2, objv, "name ?name ...?");
                return TCL_ERROR;
            }
            argv = StringifyObjects(objc, objv);
            result = TclFileMakeDirsCmd(interp, objc, argv);
            ckfree((char *) argv);
            return result;
        }
        case FILE_NATIVENAME: {
            char *fileName;
            Tcl_DString ds;

            if (objc != 3) {
                goto only3Args;
            }
            fileName = Tcl_GetString(objv[2]);
            fileName = Tcl_TranslateFileName(interp, fileName, &ds);
            if (fileName == NULL) {
                return TCL_ERROR;
            }
            Tcl_SetStringObj(resultPtr, fileName, Tcl_DStringLength(&ds));
            Tcl_DStringFree(&ds);
            return TCL_OK;
        }
        case FILE_OWNED: {
            int value;
            struct stat buf;
            
            if (objc != 3) {
                goto only3Args;
            }
            value = 0;
            if (GetStatBuf(NULL, objv[2], TclStat, &buf) == TCL_OK) {
                /*
                 * For Windows and Macintosh, there are no user ids 
                 * associated with a file, so we always return 1.
                 */

#if (defined(__WIN32__) || defined(MAC_TCL))
                value = 1;
#else
                value = (geteuid() == buf.st_uid);
#endif
            }       
            Tcl_SetBooleanObj(resultPtr, value);
            return TCL_OK;
        }
        case FILE_PATHTYPE: {
            char *fileName;

            if (objc != 3) {
                goto only3Args;
            }
            fileName = Tcl_GetString(objv[2]);
            switch (Tcl_GetPathType(fileName)) {
                case TCL_PATH_ABSOLUTE:
                    Tcl_SetStringObj(resultPtr, "absolute", -1);
                    break;
                case TCL_PATH_RELATIVE:
                    Tcl_SetStringObj(resultPtr, "relative", -1);
                    break;
                case TCL_PATH_VOLUME_RELATIVE:
                    Tcl_SetStringObj(resultPtr, "volumerelative", -1);
                    break;
            }
            return TCL_OK;
        }
        case FILE_READABLE: {
            if (objc != 3) {
                goto only3Args;
            }
            return CheckAccess(interp, objv[2], R_OK);
        }
        case FILE_READLINK: {
            char *fileName, *contents;
            Tcl_DString name, link;
                
            if (objc != 3) {
                goto only3Args;
            }
            
            fileName = Tcl_GetString(objv[2]);
            fileName = Tcl_TranslateFileName(interp, fileName, &name);
            if (fileName == NULL) {
                return TCL_ERROR;
            }

            /*
             * If S_IFLNK isn't defined it means that the machine doesn't
             * support symbolic links, so the file can't possibly be a
             * symbolic link.  Generate an EINVAL error, which is what
             * happens on machines that do support symbolic links when
             * you invoke readlink on a file that isn't a symbolic link.
             */

#ifndef S_IFLNK
            contents = NULL;
            errno = EINVAL;
#else
            contents = TclpReadlink(fileName, &link);
#endif /* S_IFLNK */

            Tcl_DStringFree(&name);
            if (contents == NULL) {
                Tcl_AppendResult(interp, "could not readlink \"", 
                        Tcl_GetString(objv[2]), "\": ", 
                        Tcl_PosixError(interp), (char *) NULL);
                return TCL_ERROR;
            }
            Tcl_DStringResult(interp, &link);
            return TCL_OK;
        }
        case FILE_RENAME: {
            int result;
            char **argv;

            argv = StringifyObjects(objc, objv);
            result = TclFileRenameCmd(interp, objc, argv);
            ckfree((char *) argv);
            return result;
        }
        case FILE_ROOTNAME: {
            int length;
            char *fileName, *extension;
            
            if (objc != 3) {
                goto only3Args;
            }
            fileName = Tcl_GetStringFromObj(objv[2], &length);
            extension = TclGetExtension(fileName);
            if (extension == NULL) {
                Tcl_SetObjResult(interp, objv[2]);
            } else {
                Tcl_SetStringObj(resultPtr, fileName,
                        (int) (length - strlen(extension)));
            }
            return TCL_OK;
        }
        case FILE_SIZE: {
            struct stat buf;
            
            if (objc != 3) {
                goto only3Args;
            }
            if (GetStatBuf(interp, objv[2], TclStat, &buf) != TCL_OK) {
                return TCL_ERROR;
            }
            Tcl_SetLongObj(resultPtr, (long) buf.st_size);
            return TCL_OK;
        }
        case FILE_SPLIT: {
            int i, argc;
            char **argv;
            char *fileName;
            Tcl_Obj *objPtr;
            
            if (objc != 3) {
                goto only3Args;
            }
            fileName = Tcl_GetString(objv[2]);
            Tcl_SplitPath(fileName, &argc, &argv);
            for (i = 0; i < argc; i++) {
                objPtr = Tcl_NewStringObj(argv[i], -1);
                Tcl_ListObjAppendElement(NULL, resultPtr, objPtr);
            }
            ckfree((char *) argv);
            return TCL_OK;
        }
        case FILE_STAT: {
            char *varName;
            struct stat buf;
            
            if (objc != 4) {
                Tcl_WrongNumArgs(interp, 1, objv, "stat name varName");
                return TCL_ERROR;
            }
            if (GetStatBuf(interp, objv[2], TclStat, &buf) != TCL_OK) {
                return TCL_ERROR;
            }
            varName = Tcl_GetString(objv[3]);
            return StoreStatData(interp, varName, &buf);
        }
        case FILE_TAIL: {
            int argc;
            char **argv;

            if (objc != 3) {
                goto only3Args;
            }
            if (SplitPath(interp, objv[2], &argc, &argv) != TCL_OK) {
                return TCL_ERROR;
            }

            /*
             * Return the last component, unless it is the only component,
             * and it is the root of an absolute path.
             */

            if (argc > 0) {
                if ((argc > 1)
                        || (Tcl_GetPathType(argv[0]) == TCL_PATH_RELATIVE)) {
                    Tcl_SetStringObj(resultPtr, argv[argc - 1], -1);
                }
            }
            ckfree((char *) argv);
            return TCL_OK;
        }
        case FILE_TYPE: {
            struct stat buf;

            if (objc != 3) {
                goto only3Args;
            }
            if (GetStatBuf(interp, objv[2], TclpLstat, &buf) != TCL_OK) {
                return TCL_ERROR;
            }
            Tcl_SetStringObj(resultPtr, 
                    GetTypeFromMode((unsigned short) buf.st_mode), -1);
            return TCL_OK;
        }
        case FILE_VOLUMES: {
            if (objc != 2) {
                Tcl_WrongNumArgs(interp, 2, objv, NULL);
                return TCL_ERROR;
            }
            return TclpListVolumes(interp);
        }
        case FILE_WRITABLE: {
            if (objc != 3) {
                goto only3Args;
            }
            return CheckAccess(interp, objv[2], W_OK);
        }
    }

    only3Args:
    Tcl_WrongNumArgs(interp, 2, objv, "name");
    return TCL_ERROR;
}

/*
 *---------------------------------------------------------------------------
 *
 * SplitPath --
 *
 *      Utility procedure used by Tcl_FileObjCmd() to split a path.
 *      Differs from standard Tcl_SplitPath in its handling of home
 *      directories; Tcl_SplitPath preserves the "~" while this
 *      procedure computes the actual full path name.
 *
 * Results:
 *      The return value is TCL_OK if the path could be split, TCL_ERROR
 *      otherwise.  If TCL_ERROR was returned, an error message is left
 *      in interp.  If TCL_OK was returned, *argvPtr is set to a newly
 *      allocated array of strings that represent the individual
 *      directories in the specified path, and *argcPtr is filled with
 *      the length of that array.
 *
 * Side effects:
 *      Memory allocated.  The caller must eventually free this memory
 *      by calling ckfree() on *argvPtr.
 *
 *---------------------------------------------------------------------------
 */

static int
SplitPath(interp, objPtr, argcPtr, argvPtr)
    Tcl_Interp *interp;         /* Interp for error return.  May be NULL. */
    Tcl_Obj *objPtr;            /* Path to be split. */
    int *argcPtr;               /* Filled with length of following array. */
    char ***argvPtr;            /* Filled with array of strings representing
                                 * the elements of the specified path. */
{
    char *fileName;

    fileName = Tcl_GetString(objPtr);

    /*
     * If there is only one element, and it starts with a tilde,
     * perform tilde substitution and resplit the path.
     */

    Tcl_SplitPath(fileName, argcPtr, argvPtr);
    if ((*argcPtr == 1) && (fileName[0] == '~')) {
        Tcl_DString ds;
        
        ckfree((char *) *argvPtr);
        fileName = Tcl_TranslateFileName(interp, fileName, &ds);
        if (fileName == NULL) {
            return TCL_ERROR;
        }
        Tcl_SplitPath(fileName, argcPtr, argvPtr);
        Tcl_DStringFree(&ds);
    }
    return TCL_OK;
}

/*
 *---------------------------------------------------------------------------
 *
 * CheckAccess --
 *
 *      Utility procedure used by Tcl_FileObjCmd() to query file
 *      attributes available through the access() system call.
 *
 * Results:
 *      Always returns TCL_OK.  Sets interp's result to boolean true or
 *      false depending on whether the file has the specified attribute.
 *
 * Side effects:
 *      None.
 *
 *---------------------------------------------------------------------------
 */
  
static int
CheckAccess(interp, objPtr, mode)
    Tcl_Interp *interp;         /* Interp for status return.  Must not be
                                 * NULL. */
    Tcl_Obj *objPtr;            /* Name of file to check. */
    int mode;                   /* Attribute to check; passed as argument to
                                 * access(). */
{
    int value;
    char *fileName;
    Tcl_DString ds;
    
    fileName = Tcl_GetString(objPtr);
    fileName = Tcl_TranslateFileName(interp, fileName, &ds);
    if (fileName == NULL) {
        value = 0;
    } else {
        value = (TclAccess(fileName, mode) == 0);
        Tcl_DStringFree(&ds);
    }
    Tcl_SetBooleanObj(Tcl_GetObjResult(interp), value);

    return TCL_OK;
}

/*
 *---------------------------------------------------------------------------
 *
 * GetStatBuf --
 *
 *      Utility procedure used by Tcl_FileObjCmd() to query file
 *      attributes available through the stat() or lstat() system call.
 *
 * Results:
 *      The return value is TCL_OK if the specified file exists and can
 *      be stat'ed, TCL_ERROR otherwise.  If TCL_ERROR is returned, an
 *      error message is left in interp's result.  If TCL_OK is returned,
 *      *statPtr is filled with information about the specified file.
 *
 * Side effects:
 *      None.
 *
 *---------------------------------------------------------------------------
 */

static int
GetStatBuf(interp, objPtr, statProc, statPtr)
    Tcl_Interp *interp;         /* Interp for error return.  May be NULL. */
    Tcl_Obj *objPtr;            /* Path name to examine. */
    StatProc *statProc;         /* Either stat() or lstat() depending on
                                 * desired behavior. */
    struct stat *statPtr;       /* Filled with info about file obtained by
                                 * calling (*statProc)(). */
{
    char *fileName;
    Tcl_DString ds;
    int status;
    
    fileName = Tcl_GetString(objPtr);
    fileName = Tcl_TranslateFileName(interp, fileName, &ds);
    if (fileName == NULL) {
        return TCL_ERROR;
    }

    status = (*statProc)(Tcl_DStringValue(&ds), statPtr);
    Tcl_DStringFree(&ds);
    
    if (status < 0) {
        if (interp != NULL) {
            Tcl_AppendResult(interp, "could not read \"",
                    Tcl_GetString(objPtr), "\": ",
                    Tcl_PosixError(interp), (char *) NULL);
        }
        return TCL_ERROR;
    }
    return TCL_OK;
}

/*
 *----------------------------------------------------------------------
 *
 * StoreStatData --
 *
 *      This is a utility procedure that breaks out the fields of a
 *      "stat" structure and stores them in textual form into the
 *      elements of an associative array.
 *
 * Results:
 *      Returns a standard Tcl return value.  If an error occurs then
 *      a message is left in interp's result.
 *
 * Side effects:
 *      Elements of the associative array given by "varName" are modified.
 *
 *----------------------------------------------------------------------
 */

static int
StoreStatData(interp, varName, statPtr)
    Tcl_Interp *interp;                 /* Interpreter for error reports. */
    char *varName;                      /* Name of associative array variable
                                         * in which to store stat results. */
    struct stat *statPtr;               /* Pointer to buffer containing
                                         * stat data to store in varName. */
{
    char string[TCL_INTEGER_SPACE];

    TclFormatInt(string, (long) statPtr->st_dev);
    if (Tcl_SetVar2(interp, varName, "dev", string, TCL_LEAVE_ERR_MSG)
            == NULL) {
        return TCL_ERROR;
    }
    TclFormatInt(string, (long) statPtr->st_ino);
    if (Tcl_SetVar2(interp, varName, "ino", string, TCL_LEAVE_ERR_MSG)
            == NULL) {
        return TCL_ERROR;
    }
    TclFormatInt(string, (unsigned short) statPtr->st_mode);
    if (Tcl_SetVar2(interp, varName, "mode", string, TCL_LEAVE_ERR_MSG)
            == NULL) {
        return TCL_ERROR;
    }
    TclFormatInt(string, (long) statPtr->st_nlink);
    if (Tcl_SetVar2(interp, varName, "nlink", string, TCL_LEAVE_ERR_MSG)
            == NULL) {
        return TCL_ERROR;
    }
    TclFormatInt(string, (long) statPtr->st_uid);
    if (Tcl_SetVar2(interp, varName, "uid", string, TCL_LEAVE_ERR_MSG)
            == NULL) {
        return TCL_ERROR;
    }
    TclFormatInt(string, (long) statPtr->st_gid);
    if (Tcl_SetVar2(interp, varName, "gid", string, TCL_LEAVE_ERR_MSG)
            == NULL) {
        return TCL_ERROR;
    }
    sprintf(string, "%lu", (unsigned long) statPtr->st_size);
    if (Tcl_SetVar2(interp, varName, "size", string, TCL_LEAVE_ERR_MSG)
            == NULL) {
        return TCL_ERROR;
    }
    TclFormatInt(string, (long) statPtr->st_atime);
    if (Tcl_SetVar2(interp, varName, "atime", string, TCL_LEAVE_ERR_MSG)
            == NULL) {
        return TCL_ERROR;
    }
    TclFormatInt(string, (long) statPtr->st_mtime);
    if (Tcl_SetVar2(interp, varName, "mtime", string, TCL_LEAVE_ERR_MSG)
            == NULL) {
        return TCL_ERROR;
    }
    TclFormatInt(string, (long) statPtr->st_ctime);
    if (Tcl_SetVar2(interp, varName, "ctime", string, TCL_LEAVE_ERR_MSG)
            == NULL) {
        return TCL_ERROR;
    }
    if (Tcl_SetVar2(interp, varName, "type",
            GetTypeFromMode((unsigned short) statPtr->st_mode), 
            TCL_LEAVE_ERR_MSG) == NULL) {
        return TCL_ERROR;
    }
    return TCL_OK;
}

/*
 *----------------------------------------------------------------------
 *
 * GetTypeFromMode --
 *
 *      Given a mode word, returns a string identifying the type of a
 *      file.
 *
 * Results:
 *      A static text string giving the file type from mode.
 *
 * Side effects:
 *      None.
 *
 *----------------------------------------------------------------------
 */

static char *
GetTypeFromMode(mode)
    int mode;
{
    if (S_ISREG(mode)) {
        return "file";
    } else if (S_ISDIR(mode)) {
        return "directory";
    } else if (S_ISCHR(mode)) {
        return "characterSpecial";
    } else if (S_ISBLK(mode)) {
        return "blockSpecial";
    } else if (S_ISFIFO(mode)) {
        return "fifo";
#ifdef S_ISLNK
    } else if (S_ISLNK(mode)) {
        return "link";
#endif
#ifdef S_ISSOCK
    } else if (S_ISSOCK(mode)) {
        return "socket";
#endif
    }
    return "unknown";
}

/*
 *----------------------------------------------------------------------
 *
 * Tcl_ForObjCmd --
 *
 *      This procedure is invoked to process the "for" Tcl command.
 *      See the user documentation for details on what it does.
 *
 *      With the bytecode compiler, this procedure is only called when
 *      a command name is computed at runtime, and is "for" or the name
 *      to which "for" was renamed: e.g.,
 *      "set z for; $z {set i 0} {$i<100} {incr i} {puts $i}"
 *
 * Results:
 *      A standard Tcl result.
 *
 * Side effects:
 *      See the user documentation.
 *
 *----------------------------------------------------------------------
 */

        /* ARGSUSED */
int
Tcl_ForObjCmd(dummy, interp, objc, objv)
    ClientData dummy;                   /* Not used. */
    Tcl_Interp *interp;                 /* Current interpreter. */
    int objc;                           /* Number of arguments. */
    Tcl_Obj *CONST objv[];      /* Argument objects. */
{
    int result, value;

    if (objc != 5) {
        Tcl_WrongNumArgs(interp, 1, objv, "start test next command");
        return TCL_ERROR;
    }

    result = Tcl_EvalObjEx(interp, objv[1], 0);
    if (result != TCL_OK) {
        if (result == TCL_ERROR) {
            Tcl_AddErrorInfo(interp, "\n    (\"for\" initial command)");
        }
        return result;
    }
    while (1) {
        /*
         * We need to reset the result before passing it off to
         * Tcl_ExprBooleanObj.  Otherwise, any error message will be appended
         * to the result of the last evaluation.
         */

        Tcl_ResetResult(interp);
        result = Tcl_ExprBooleanObj(interp, objv[2], &value);
        if (result != TCL_OK) {
            return result;
        }
        if (!value) {
            break;
        }
        result = Tcl_EvalObjEx(interp, objv[4], 0);
        if ((result != TCL_OK) && (result != TCL_CONTINUE)) {
            if (result == TCL_ERROR) {
                char msg[32 + TCL_INTEGER_SPACE];

                sprintf(msg, "\n    (\"for\" body line %d)",interp->errorLine);
                Tcl_AddErrorInfo(interp, msg);
            }
            break;
        }
        result = Tcl_EvalObjEx(interp, objv[3], 0);
        if (result == TCL_BREAK) {
            break;
        } else if (result != TCL_OK) {
            if (result == TCL_ERROR) {
                Tcl_AddErrorInfo(interp, "\n    (\"for\" loop-end command)");
            }
            return result;
        }
    }
    if (result == TCL_BREAK) {
        result = TCL_OK;
    }
    if (result == TCL_OK) {
        Tcl_ResetResult(interp);
    }
    return result;
}

/*
 *----------------------------------------------------------------------
 *
 * Tcl_ForeachObjCmd --
 *
 *      This object-based procedure is invoked to process the "foreach" Tcl
 *      command.  See the user documentation for details on what it does.
 *
 * Results:
 *      A standard Tcl object result.
 *
 * Side effects:
 *      See the user documentation.
 *
 *----------------------------------------------------------------------
 */

        /* ARGSUSED */
int
Tcl_ForeachObjCmd(dummy, interp, objc, objv)
    ClientData dummy;           /* Not used. */
    Tcl_Interp *interp;         /* Current interpreter. */
    int objc;                   /* Number of arguments. */
    Tcl_Obj *CONST objv[];      /* Argument objects. */
{
    int result = TCL_OK;
    int i;                      /* i selects a value list */
    int j, maxj;                /* Number of loop iterations */
    int v;                      /* v selects a loop variable */
    int numLists;               /* Count of value lists */
    Tcl_Obj *bodyPtr;

    /*
     * We copy the argument object pointers into a local array to avoid
     * the problem that "objv" might become invalid. It is a pointer into
     * the evaluation stack and that stack might be grown and reallocated
     * if the loop body requires a large amount of stack space.
     */
    
#define NUM_ARGS 9
    Tcl_Obj *(argObjStorage[NUM_ARGS]);
    Tcl_Obj **argObjv = argObjStorage;
    
#define STATIC_LIST_SIZE 4
    int indexArray[STATIC_LIST_SIZE];     /* Array of value list indices */
    int varcListArray[STATIC_LIST_SIZE];  /* # loop variables per list */
    Tcl_Obj **varvListArray[STATIC_LIST_SIZE]; /* Array of var name lists */
    int argcListArray[STATIC_LIST_SIZE];  /* Array of value list sizes */
    Tcl_Obj **argvListArray[STATIC_LIST_SIZE]; /* Array of value lists */

    int *index = indexArray;
    int *varcList = varcListArray;
    Tcl_Obj ***varvList = varvListArray;
    int *argcList = argcListArray;
    Tcl_Obj ***argvList = argvListArray;

    if (objc < 4 || (objc%2 != 0)) {
        Tcl_WrongNumArgs(interp, 1, objv,
                "varList list ?varList list ...? command");
        return TCL_ERROR;
    }

    /*
     * Create the object argument array "argObjv". Make sure argObjv is
     * large enough to hold the objc arguments.
     */

    if (objc > NUM_ARGS) {
        argObjv = (Tcl_Obj **) ckalloc(objc * sizeof(Tcl_Obj *));
    }
    for (i = 0;  i < objc;  i++) {
        argObjv[i] = objv[i];
    }

    /*
     * Manage numList parallel value lists.
     * argvList[i] is a value list counted by argcList[i]
     * varvList[i] is the list of variables associated with the value list
     * varcList[i] is the number of variables associated with the value list
     * index[i] is the current pointer into the value list argvList[i]
     */

    numLists = (objc-2)/2;
    if (numLists > STATIC_LIST_SIZE) {
        index = (int *) ckalloc(numLists * sizeof(int));
        varcList = (int *) ckalloc(numLists * sizeof(int));
        varvList = (Tcl_Obj ***) ckalloc(numLists * sizeof(Tcl_Obj **));
        argcList = (int *) ckalloc(numLists * sizeof(int));
        argvList = (Tcl_Obj ***) ckalloc(numLists * sizeof(Tcl_Obj **));
    }
    for (i = 0;  i < numLists;  i++) {
        index[i] = 0;
        varcList[i] = 0;
        varvList[i] = (Tcl_Obj **) NULL;
        argcList[i] = 0;
        argvList[i] = (Tcl_Obj **) NULL;
    }

    /*
     * Break up the value lists and variable lists into elements
     */

    maxj = 0;
    for (i = 0;  i < numLists;  i++) {
        result = Tcl_ListObjGetElements(interp, argObjv[1+i*2],
                &varcList[i], &varvList[i]);
        if (result != TCL_OK) {
            goto done;
        }
        if (varcList[i] < 1) {
            Tcl_AppendToObj(Tcl_GetObjResult(interp),
                    "foreach varlist is empty", -1);
            result = TCL_ERROR;
            goto done;
        }
        
        result = Tcl_ListObjGetElements(interp, argObjv[2+i*2],
                &argcList[i], &argvList[i]);
        if (result != TCL_OK) {
            goto done;
        }
        
        j = argcList[i] / varcList[i];
        if ((argcList[i] % varcList[i]) != 0) {
            j++;
        }
        if (j > maxj) {
            maxj = j;
        }
    }

    /*
     * Iterate maxj times through the lists in parallel
     * If some value lists run out of values, set loop vars to ""
     */
    
    bodyPtr = argObjv[objc-1];
    for (j = 0;  j < maxj;  j++) {
        for (i = 0;  i < numLists;  i++) {
            /*
             * If a variable or value list object has been converted to
             * another kind of Tcl object, convert it back to a list object
             * and refetch the pointer to its element array.
             */

            if (argObjv[1+i*2]->typePtr != &tclListType) {
                result = Tcl_ListObjGetElements(interp, argObjv[1+i*2],
                        &varcList[i], &varvList[i]);
                if (result != TCL_OK) {
                    panic("Tcl_ForeachObjCmd: could not reconvert variable list %d to a list object\n", i);
                }
            }
            if (argObjv[2+i*2]->typePtr != &tclListType) {
                result = Tcl_ListObjGetElements(interp, argObjv[2+i*2],
                        &argcList[i], &argvList[i]);
                if (result != TCL_OK) {
                    panic("Tcl_ForeachObjCmd: could not reconvert value list %d to a list object\n", i);
                }
            }
            
            for (v = 0;  v < varcList[i];  v++) {
                int k = index[i]++;
                Tcl_Obj *valuePtr, *varValuePtr;
                int isEmptyObj = 0;
                
                if (k < argcList[i]) {
                    valuePtr = argvList[i][k];
                } else {
                    valuePtr = Tcl_NewObj(); /* empty string */
                    isEmptyObj = 1;
                }
                varValuePtr = Tcl_ObjSetVar2(interp, varvList[i][v],
                        NULL, valuePtr, 0);
                if (varValuePtr == NULL) {
                    if (isEmptyObj) {
                        Tcl_DecrRefCount(valuePtr);
                    }
                    Tcl_ResetResult(interp);
                    Tcl_AppendStringsToObj(Tcl_GetObjResult(interp),
                        "couldn't set loop variable: \"",
                        Tcl_GetString(varvList[i][v]), "\"", (char *) NULL);
                    result = TCL_ERROR;
                    goto done;
                }

            }
        }

        result = Tcl_EvalObjEx(interp, bodyPtr, 0);
        if (result != TCL_OK) {
            if (result == TCL_CONTINUE) {
                result = TCL_OK;
            } else if (result == TCL_BREAK) {
                result = TCL_OK;
                break;
            } else if (result == TCL_ERROR) {
                char msg[32 + TCL_INTEGER_SPACE];

                sprintf(msg, "\n    (\"foreach\" body line %d)",
                        interp->errorLine);
                Tcl_AddObjErrorInfo(interp, msg, -1);
                break;
            } else {
                break;
            }
        }
    }
    if (result == TCL_OK) {
        Tcl_ResetResult(interp);
    }

    done:
    if (numLists > STATIC_LIST_SIZE) {
        ckfree((char *) index);
        ckfree((char *) varcList);
        ckfree((char *) argcList);
        ckfree((char *) varvList);
        ckfree((char *) argvList);
    }
    if (argObjv != argObjStorage) {
        ckfree((char *) argObjv);
    }
    return result;
#undef STATIC_LIST_SIZE
#undef NUM_ARGS
}

/*
 *----------------------------------------------------------------------
 *
 * Tcl_FormatObjCmd --
 *
 *      This procedure is invoked to process the "format" Tcl command.
 *      See the user documentation for details on what it does.
 *
 * Results:
 *      A standard Tcl result.
 *
 * Side effects:
 *      See the user documentation.
 *
 *----------------------------------------------------------------------
 */

        /* ARGSUSED */
int
Tcl_FormatObjCmd(dummy, interp, objc, objv)
    ClientData dummy;           /* Not used. */
    Tcl_Interp *interp;         /* Current interpreter. */
    int objc;                   /* Number of arguments. */
    Tcl_Obj *CONST objv[];      /* Argument objects. */
{
    char *format;               /* Used to read characters from the format
                                 * string. */
    int formatLen;              /* The length of the format string */
    char *endPtr;               /* Points to the last char in format array */
    char newFormat[40];         /* A new format specifier is generated here. */
    int width;                  /* Field width from field specifier, or 0 if
                                 * no width given. */
    int precision;              /* Field precision from field specifier, or 0
                                 * if no precision given. */
    int size;                   /* Number of bytes needed for result of
                                 * conversion, based on type of conversion
                                 * ("e", "s", etc.), width, and precision. */
    int intValue;               /* Used to hold value to pass to sprintf, if
                                 * it's a one-word integer or char value */
    char *ptrValue = NULL;      /* Used to hold value to pass to sprintf, if
                                 * it's a one-word value. */
    double doubleValue;         /* Used to hold value to pass to sprintf if
                                 * it's a double value. */
    int whichValue;             /* Indicates which of intValue, ptrValue,
                                 * or doubleValue has the value to pass to
                                 * sprintf, according to the following
                                 * definitions: */
#   define INT_VALUE 0
#   define CHAR_VALUE 1
#   define PTR_VALUE 2
#   define DOUBLE_VALUE 3
#   define STRING_VALUE 4
#   define MAX_FLOAT_SIZE 320
    
    Tcl_Obj *resultPtr;         /* Where result is stored finally. */
    char staticBuf[MAX_FLOAT_SIZE + 1];
                                /* A static buffer to copy the format results 
                                 * into */
    char *dst = staticBuf;      /* The buffer that sprintf writes into each
                                 * time the format processes a specifier */
    int dstSize = MAX_FLOAT_SIZE;
                                /* The size of the dst buffer */
    int noPercent;              /* Special case for speed:  indicates there's
                                 * no field specifier, just a string to copy.*/
    int objIndex;               /* Index of argument to substitute next. */
    int gotXpg = 0;             /* Non-zero means that an XPG3 %n$-style
                                 * specifier has been seen. */
    int gotSequential = 0;      /* Non-zero means that a regular sequential
                                 * (non-XPG3) conversion specifier has been
                                 * seen. */
    int useShort;               /* Value to be printed is short (half word). */
    char *end;                  /* Used to locate end of numerical fields. */
    int stringLen = 0;          /* Length of string in characters rather
                                 * than bytes.  Used for %s substitution. */
    int gotMinus;               /* Non-zero indicates that a minus flag has
                                 * been seen in the current field. */
    int gotPrecision;           /* Non-zero indicates that a precision has
                                 * been set for the current field. */
    int gotZero;                /* Non-zero indicates that a zero flag has
                                 * been seen in the current field. */

    /*
     * This procedure is a bit nasty.  The goal is to use sprintf to
     * do most of the dirty work.  There are several problems:
     * 1. this procedure can't trust its arguments.
     * 2. we must be able to provide a large enough result area to hold
     *    whatever's generated.  This is hard to estimate.
     * 3. there's no way to move the arguments from objv to the call
     *    to sprintf in a reasonable way.  This is particularly nasty
     *    because some of the arguments may be two-word values (doubles).
     * So, what happens here is to scan the format string one % group
     * at a time, making many individual calls to sprintf.
     */

    if (objc < 2) {
        Tcl_WrongNumArgs(interp, 1, objv, "formatString ?arg arg ...?");
        return TCL_ERROR;
    }

    format = (char *) Tcl_GetStringFromObj(objv[1], &formatLen);
    endPtr = format + formatLen;
    resultPtr = Tcl_NewObj();
    objIndex = 2;

    while (format < endPtr) {
        register char *newPtr = newFormat;

        width = precision = noPercent = useShort = 0;
        gotZero = gotMinus = gotPrecision = 0;
        whichValue = PTR_VALUE;

        /*
         * Get rid of any characters before the next field specifier.
         */
        if (*format != '%') {
            ptrValue = format;
            while ((*format != '%') && (format < endPtr)) {
                format++;
            }
            size = format - ptrValue;
            noPercent = 1;
            goto doField;
        }

        if (format[1] == '%') {
            ptrValue = format;
            size = 1;
            noPercent = 1;
            format += 2;
            goto doField;
        }

        /*
         * Parse off a field specifier, compute how many characters
         * will be needed to store the result, and substitute for
         * "*" size specifiers.
         */
        *newPtr = '%';
        newPtr++;
        format++;
        if (isdigit(UCHAR(*format))) { /* INTL: Tcl source. */
            int tmp;

            /*
             * Check for an XPG3-style %n$ specification.  Note: there
             * must not be a mixture of XPG3 specs and non-XPG3 specs
             * in the same format string.
             */

            tmp = strtoul(format, &end, 10);    /* INTL: "C" locale. */
            if (*end != '$') {
                goto notXpg;
            }
            format = end+1;
            gotXpg = 1;
            if (gotSequential) {
                goto mixedXPG;
            }
            objIndex = tmp+1;
            if ((objIndex < 2) || (objIndex >= objc)) {
                goto badIndex;
            }
            goto xpgCheckDone;
        }

        notXpg:
        gotSequential = 1;
        if (gotXpg) {
            goto mixedXPG;
        }

        xpgCheckDone:
        while ((*format == '-') || (*format == '#') || (*format == '0')
                || (*format == ' ') || (*format == '+')) {
            if (*format == '-') {
                gotMinus = 1;
            }
            if (*format == '0') {
                /*
                 * This will be handled by sprintf for numbers, but we
                 * need to do the char/string ones ourselves
                 */
                gotZero = 1;
            }
            *newPtr = *format;
            newPtr++;
            format++;
        }
        if (isdigit(UCHAR(*format))) { /* INTL: Tcl source. */
            width = strtoul(format, &end, 10);  /* INTL: Tcl source. */
            format = end;
        } else if (*format == '*') {
            if (objIndex >= objc) {
                goto badIndex;
            }
            if (Tcl_GetIntFromObj(interp,       /* INTL: Tcl source. */
                    objv[objIndex], &width) != TCL_OK) {
                goto fmtError;
            }
            if (width < 0) {
                width = -width;
                *newPtr = '-';
                gotMinus = 1;
                newPtr++;
            }
            objIndex++;
            format++;
        }
        if (width > 100000) {
            /*
             * Don't allow arbitrarily large widths:  could cause core
             * dump when we try to allocate a zillion bytes of memory
             * below.
             */

            width = 100000;
        } else if (width < 0) {
            width = 0;
        }
        if (width != 0) {
            TclFormatInt(newPtr, width);        /* INTL: printf format. */
            while (*newPtr != 0) {
                newPtr++;
            }
        }
        if (*format == '.') {
            *newPtr = '.';
            newPtr++;
            format++;
            gotPrecision = 1;
        }
        if (isdigit(UCHAR(*format))) { /* INTL: Tcl source. */
            precision = strtoul(format, &end, 10);  /* INTL: "C" locale. */
            format = end;
        } else if (*format == '*') {
            if (objIndex >= objc) {
                goto badIndex;
            }
            if (Tcl_GetIntFromObj(interp,       /* INTL: Tcl source. */
                    objv[objIndex], &precision) != TCL_OK) {
                goto fmtError;
            }
            objIndex++;
            format++;
        }
        if (gotPrecision) {
            TclFormatInt(newPtr, precision);    /* INTL: printf format. */
            while (*newPtr != 0) {
                newPtr++;
            }
        }
        if (*format == 'l') {
            format++;
        } else if (*format == 'h') {
            useShort = 1;
            *newPtr = 'h';
            newPtr++;
            format++;
        }
        *newPtr = *format;
        newPtr++;
        *newPtr = 0;
        if (objIndex >= objc) {
            goto badIndex;
        }
        switch (*format) {
            case 'i':
                newPtr[-1] = 'd';
            case 'd':
            case 'o':
            case 'u':
            case 'x':
            case 'X':
                if (Tcl_GetIntFromObj(interp,   /* INTL: Tcl source. */
                        objv[objIndex], &intValue) != TCL_OK) {
                    goto fmtError;
                }
                whichValue = INT_VALUE;
                size = 40 + precision;
                break;
            case 's':
                /*
                 * Compute the length of the string in characters and add
                 * any additional space required by the field width.  All of
                 * the extra characters will be spaces, so one byte per
                 * character is adequate.
                 */

                whichValue = STRING_VALUE;
                ptrValue = Tcl_GetStringFromObj(objv[objIndex], &size);
                stringLen = Tcl_NumUtfChars(ptrValue, size);
                if (gotPrecision && (precision < stringLen)) {
                    stringLen = precision;
                }
                size = Tcl_UtfAtIndex(ptrValue, stringLen) - ptrValue;
                if (width > stringLen) {
                    size += (width - stringLen);
                }
                break;
            case 'c':
                if (Tcl_GetIntFromObj(interp,   /* INTL: Tcl source. */
                        objv[objIndex], &intValue) != TCL_OK) {
                    goto fmtError;
                }
                whichValue = CHAR_VALUE;
                size = width + TCL_UTF_MAX;
                break;
            case 'e':
            case 'E':
            case 'f':
            case 'g':
            case 'G':
                if (Tcl_GetDoubleFromObj(interp, /* INTL: Tcl source. */
                        objv[objIndex], &doubleValue) != TCL_OK) {
                    goto fmtError;
                }
                whichValue = DOUBLE_VALUE;
                size = MAX_FLOAT_SIZE;
                if (precision > 10) {
                    size += precision;
                }
                break;
            case 0:
                Tcl_SetResult(interp,
                        "format string ended in middle of field specifier",
                        TCL_STATIC);
                goto fmtError;
            default: {
                char buf[40];
                sprintf(buf, "bad field specifier \"%c\"", *format);
                Tcl_SetResult(interp, buf, TCL_VOLATILE);
                goto fmtError;
            }
        }
        objIndex++;
        format++;

        /*
         * Make sure that there's enough space to hold the formatted
         * result, then format it.
         */

        doField:
        if (width > size) {
            size = width;
        }
        if (noPercent) {
            Tcl_AppendToObj(resultPtr, ptrValue, size);
        } else {
            if (size > dstSize) {
                if (dst != staticBuf) {
                    ckfree(dst);
                }
                dst = (char *) ckalloc((unsigned) (size + 1));
                dstSize = size;
            }
            switch (whichValue) {
                case DOUBLE_VALUE: {
                    sprintf(dst, newFormat, doubleValue); /* INTL: user locale. */
                    break;
                }
                case INT_VALUE: {
                    if (useShort) {
                        sprintf(dst, newFormat, (short) intValue);
                    } else {
                        sprintf(dst, newFormat, intValue);
                    }
                    break;
                }
                case CHAR_VALUE: {
                    char *ptr;
                    char padChar = (gotZero ? '0' : ' ');
                    ptr = dst;
                    if (!gotMinus) {
                        for ( ; --width > 0; ptr++) {
                            *ptr = padChar;
                        }
                    }
                    ptr += Tcl_UniCharToUtf(intValue, ptr);
                    for ( ; --width > 0; ptr++) {
                        *ptr = padChar;
                    }
                    *ptr = '\0';
                    break;
                }
                case STRING_VALUE: {
                    char *ptr;
                    char padChar = (gotZero ? '0' : ' ');
                    int pad;

                    ptr = dst;
                    if (width > stringLen) {
                        pad = width - stringLen;
                    } else {
                        pad = 0;
                    }

                    if (!gotMinus) {
                        while (pad > 0) {
                            *ptr++ = padChar;
                            pad--;
                        }
                    }

                    size = Tcl_UtfAtIndex(ptrValue, stringLen) - ptrValue; 
                    if (size) {
                        memcpy(ptr, ptrValue, (size_t) size);
                        ptr += size;
                    }
                    while (pad > 0) {
                        *ptr++ = padChar;
                        pad--;
                    }
                    *ptr = '\0';
                    break;
                }
                default: {
                    sprintf(dst, newFormat, ptrValue);
                    break;
                }
            }
            Tcl_AppendToObj(resultPtr, dst, -1);
        }
    }

    Tcl_SetObjResult(interp, resultPtr);
    if(dst != staticBuf) {
        ckfree(dst);
    }
    return TCL_OK;

    mixedXPG:
    Tcl_SetResult(interp, 
            "cannot mix \"%\" and \"%n$\" conversion specifiers", TCL_STATIC);
    goto fmtError;

    badIndex:
    if (gotXpg) {
        Tcl_SetResult(interp, 
                "\"%n$\" argument index out of range", TCL_STATIC);
    } else {
        Tcl_SetResult(interp, 
                "not enough arguments for all format specifiers", TCL_STATIC);
    }

    fmtError:
    if(dst != staticBuf) {
        ckfree(dst);
    }
    Tcl_DecrRefCount(resultPtr);
    return TCL_ERROR;
}

/*
 *---------------------------------------------------------------------------
 *
 * StringifyObjects --
 *
 *      Helper function to bridge the gap between an object-based procedure
 *      and an older string-based procedure.
 * 
 *      Given an array of objects, allocate an array that consists of the
 *      string representations of those objects.
 *
 * Results:
 *      The return value is a pointer to the newly allocated array of
 *      strings.  Elements 0 to (objc-1) of the string array point to the
 *      string representation of the corresponding element in the source
 *      object array; element objc of the string array is NULL.
 *
 * Side effects:
 *      Memory allocated.  The caller must eventually free this memory
 *      by calling ckfree() on the return value.
 *
 *---------------------------------------------------------------------------
 */

static char **
StringifyObjects(objc, objv)
    int objc;                   /* Number of arguments. */
    Tcl_Obj *CONST objv[];      /* Argument objects. */
{
    int i;
    char **argv;
    
    argv = (char **) ckalloc((objc + 1) * sizeof(char *));
    for (i = 0; i < objc; i++) {
        argv[i] = Tcl_GetString(objv[i]);
    }
    argv[i] = NULL;
    return argv;
}


/* $History: tclcmdah.c $
 * 
 * *****************  Version 1  *****************
 * User: Dtashley     Date: 1/02/01    Time: 1:28a
 * Created in $/IjuScripter, IjuConsole/Source/Tcl Base
 * Initial check-in.
 */ 

/* End of TCLCMDAH.C */