jim-array.c

   1 /*
   2  * Implements the array command for jim
   3  *
   4  * (c) 2008 Steve Bennett <steveb@workware.net.au>
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above
  13  *    copyright notice, this list of conditions and the following
  14  *    disclaimer in the documentation and/or other materials
  15  *    provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE JIM TCL PROJECT ``AS IS'' AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  19  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  21  * JIM TCL PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  22  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  26  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  28  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  *
  30  * The views and conclusions contained in the software and documentation
  31  * are those of the authors and should not be interpreted as representing
  32  * official policies, either expressed or implied, of the Jim Tcl Project.
  33  *
  34  * Based on code originally from Tcl 6.7:
  35  *
  36  * Copyright 1987-1991 Regents of the University of California
  37  * Permission to use, copy, modify, and distribute this
  38  * software and its documentation for any purpose and without
  39  * fee is hereby granted, provided that the above copyright
  40  * notice appear in all copies.  The University of California
  41  * makes no representations about the suitability of this
  42  * software for any purpose.  It is provided "as is" without
  43  * express or implied warranty.
  44  */
  45
  46 #include <limits.h>
  47 #include <stdlib.h>
  48 #include <string.h>
  49 #include <stdio.h>
  50 #include <errno.h>
  51
  52 #include <jim-subcmd.h>
  53
  54 static int array_cmd_exists(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
  55 {
  56     /* Just a regular [info exists] */
  57     Jim_SetResultInt(interp, Jim_GetVariable(interp, argv[0], 0) != 0);
  58     return JIM_OK;
  59 }
  60
  61 static int array_cmd_get(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
  62 {
  63     Jim_Obj *objPtr = Jim_GetVariable(interp, argv[0], JIM_NONE);
  64     Jim_Obj *patternObj;
  65
  66     if (!objPtr) {
  67         return JIM_OK;
  68     }
  69
  70     patternObj = (argc == 1) ? NULL : argv[1];
  71
  72     /* Optimise the "all" case */
  73     if (patternObj == NULL || Jim_CompareStringImmediate(interp, patternObj, "*")) {
  74         if (Jim_IsList(objPtr) && Jim_ListLength(interp, objPtr) % 2 == 0) {
  75             /* A list with an even number of elements */
  76             Jim_SetResult(interp, objPtr);
  77             return JIM_OK;
  78         }
  79     }
  80
  81     /* Return a list of keys and values where the keys match the pattern */
  82     return Jim_DictValues(interp, objPtr, patternObj);
  83 }
  84
  85 static int array_cmd_names(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
  86 {
  87     Jim_Obj *objPtr = Jim_GetVariable(interp, argv[0], JIM_NONE);
  88
  89     if (!objPtr) {
  90         return JIM_OK;
  91     }
  92
  93     return Jim_DictKeys(interp, objPtr, argc == 1 ? NULL : argv[1]);
  94 }
  95
  96 static int array_cmd_unset(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
  97 {
  98     int i;
  99     int len;
 100     Jim_Obj *resultObj;
 101     Jim_Obj *objPtr;
 102     Jim_Obj **dictValuesObj;
 103
 104     if (argc == 1 || Jim_CompareStringImmediate(interp, argv[1], "*")) {
 105         /* Unset the whole array */
 106         Jim_UnsetVariable(interp, argv[0], JIM_NONE);
 107         return JIM_OK;
 108     }
 109
 110     objPtr = Jim_GetVariable(interp, argv[0], JIM_NONE);
 111
 112     if (Jim_DictPairs(interp, objPtr, &dictValuesObj, &len) != JIM_OK) {
 113         return JIM_ERR;
 114     }
 115
 116     /* Create a new object with the values which don't match */
 117     resultObj = Jim_NewDictObj(interp, NULL, 0);
 118
 119     for (i = 0; i < len; i += 2) {
 120         if (!Jim_StringMatchObj(interp, argv[1], dictValuesObj[i], 0)) {
 121             Jim_DictAddElement(interp, resultObj, dictValuesObj[i], dictValuesObj[i + 1]);
 122         }
 123     }
 124     Jim_Free(dictValuesObj);
 125
 126     Jim_SetVariable(interp, argv[0], resultObj);
 127     return JIM_OK;
 128 }
 129
 130 static int array_cmd_size(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 131 {
 132     Jim_Obj *objPtr;
 133     int len = 0;
 134
 135     /* Not found means zero length */
 136     objPtr = Jim_GetVariable(interp, argv[0], JIM_NONE);
 137     if (objPtr) {
 138         len = Jim_DictSize(interp, objPtr);
 139         if (len < 0) {
 140             return JIM_ERR;
 141         }
 142     }
 143
 144     Jim_SetResultInt(interp, len);
 145
 146     return JIM_OK;
 147 }
 148
 149 static int array_cmd_stat(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 150 {
 151     Jim_Obj *objPtr = Jim_GetVariable(interp, argv[0], JIM_NONE);
 152     if (objPtr) {
 153         return Jim_DictInfo(interp, objPtr);
 154     }
 155     Jim_SetResultFormatted(interp, "\"%#s\" isn't an array", argv[0], NULL);
 156     return JIM_ERR;
 157 }
 158
 159 static int array_cmd_set(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 160 {
 161     int i;
 162     int len;
 163     Jim_Obj *listObj = argv[1];
 164     Jim_Obj *dictObj;
 165
 166     len = Jim_ListLength(interp, listObj);
 167     if (len % 2) {
 168         Jim_SetResultString(interp, "list must have an even number of elements", -1);
 169         return JIM_ERR;
 170     }
 171
 172     dictObj = Jim_GetVariable(interp, argv[0], JIM_UNSHARED);
 173     if (!dictObj) {
 174         /* Doesn't exist, so just set the list directly */
 175         return Jim_SetVariable(interp, argv[0], listObj);
 176     }
 177
 178     if (Jim_IsShared(dictObj)) {
 179         dictObj = Jim_DuplicateObj(interp, dictObj);
 180     }
 181
 182     for (i = 0; i < len; i += 2) {
 183         Jim_Obj *nameObj;
 184         Jim_Obj *valueObj;
 185
 186         Jim_ListIndex(interp, listObj, i, &nameObj, JIM_NONE);
 187         Jim_ListIndex(interp, listObj, i + 1, &valueObj, JIM_NONE);
 188
 189         Jim_DictAddElement(interp, dictObj, nameObj, valueObj);
 190     }
 191     return Jim_SetVariable(interp, argv[0], dictObj);
 192 }
 193
 194 static const jim_subcmd_type array_command_table[] = {
 195         {       "exists",
 196                 "arrayName",
 197                 array_cmd_exists,
 198                 1,
 199                 1,
 200                 /* Description: Does array exist? */
 201         },
 202         {       "get",
 203                 "arrayName ?pattern?",
 204                 array_cmd_get,
 205                 1,
 206                 2,
 207                 /* Description: Array contents as name value list */
 208         },
 209         {       "names",
 210                 "arrayName ?pattern?",
 211                 array_cmd_names,
 212                 1,
 213                 2,
 214                 /* Description: Array keys as a list */
 215         },
 216         {       "set",
 217                 "arrayName list",
 218                 array_cmd_set,
 219                 2,
 220                 2,
 221                 /* Description: Set array from list */
 222         },
 223         {       "size",
 224                 "arrayName",
 225                 array_cmd_size,
 226                 1,
 227                 1,
 228                 /* Description: Number of elements in array */
 229         },
 230         {       "stat",
 231                 "arrayName",
 232                 array_cmd_stat,
 233                 1,
 234                 1,
 235                 /* Description: Print statistics about an array */
 236         },
 237         {       "unset",
 238                 "arrayName ?pattern?",
 239                 array_cmd_unset,
 240                 1,
 241                 2,
 242                 /* Description: Unset elements of an array */
 243         },
 244         {       NULL
 245         }
 246 };
 247
 248 int Jim_arrayInit(Jim_Interp *interp)
 249 {
 250     if (Jim_PackageProvide(interp, "array", "1.0", JIM_ERRMSG))
 251         return JIM_ERR;
 252
 253     Jim_CreateCommand(interp, "array", Jim_SubCmdProc, (void *)array_command_table, NULL);
 254     return JIM_OK;
 255 }