Changeset 849 for cpp/frams/vm/classes/collectionobj.cpp

Timestamp:

01/31/19 03:47:07 (6 years ago)

Author:

Maciej Komosinski

Message:

Added Dictionary.hasKey(). Accessing non-existent dictionary keys becomes an error.

File:

• cpp/frams/vm/classes/collectionobj.cpp (modified) (7 diffs)

cpp/frams/vm/classes/collectionobj.cpp

@@ -1 +1 @@
 // This file is a part of Framsticks SDK.  http://www.framsticks.com/
-// Copyright (C) 1999-2015  Maciej Komosinski and Szymon Ulatowski.
+// Copyright (C) 1999-2019  Maciej Komosinski and Szymon Ulatowski.
 // See LICENSE.txt for details.
 
@@ -50 +50 @@
 ParamEntry dictionary_paramtab[] =
 {
-        { "Dictionary", 1, 11, "Dictionary", "Dictionary associates stored values with string keys "
+        { "Dictionary", 1, 12, "Dictionary", "Dictionary associates stored values with string keys "
         "(\"key\" is the first argument in get/set/remove functions). Integer key can be "
         "used to enumerate all elements (note that while iterating, the elements are returned in no particular order).\n"
@@ -70 +70 @@
         { "size", 0, PARAM_NOSTATIC | PARAM_READONLY, "Element count", "d", GETONLY(size), },
         { "remove", 0, PARAM_NOSTATIC, "Remove", "p(x key)", PROCEDURE(p_remove), "Removes the named or indexed element (depending on the argument type: string or int)." },
-        { "get", 0, PARAM_NOSTATIC, "Get element", "p x(x key)", PROCEDURE(p_get), "Retrieves the named or indexed element (depending on the argument type: string or int). null is returned for nonexistent keys.\nobject.get(key) can be shortened to 'object[key]'" },
+        { "get", 0, PARAM_NOSTATIC, "Get element", "p x(x key)", PROCEDURE(p_get), "Retrieves the named or indexed element (depending on the argument type: string or int). Accessing nonexistent keys is an error (use hasKey() if necessary).\nobject.get(key) can be shortened to 'object[key]'" },
         { "getKey", 0, PARAM_NOSTATIC, "Get a key", "p s(d index)", PROCEDURE(p_getKey), "Returns the key of the indexed element (0 <= index < size)" },
+        { "hasKey", 0, PARAM_NOSTATIC, "Check if key exists", "p d(s key)", PROCEDURE(p_hasKey), "Returns 1 (interpreted as true) if dictionary contains the supplied key, or 0 (false) otherwise.\nExample:\n   if (obj.hasKey(\"a\"))\n      x = obj->a;" },
         { "set", 0, PARAM_NOSTATIC, "Set element", "p x(x key,x value)", PROCEDURE(p_set), "Set element value for the specified key or index (depending on the argument type: string or int).\n"
         "Returns the value previously associated with the given key (or index).\n"
@@ -106 +107 @@
                 for (int i = data.size() - 1; i >= 0; i--)
                 {
-                ExtValue *v = (ExtValue*)data.get(i);
-                if (v) delete v;
+                        ExtValue *v = (ExtValue*)data.get(i);
+                        if (v) delete v;
                 }
         data.clear();
@@ -221 +222 @@
         {
                 double d = a - ((ExtValue*)data.get(i))->getDouble();
-                s += d*d;
+                s += d * d;
         }
         ret->setDouble(sqrt(s / max(1, data.size() - 1)));
@@ -391 +392 @@
 ExtValue DictionaryObject::get(SString key)
 {
-        ExtValue *val = (ExtValue*)hash.get(key);
-        if (val)
-                return *val;
-        return ExtValue::empty();
+        int found = 0;
+        ExtValue *val = (ExtValue*)hash.get(key, &found);
+        if (found == 0)
+        {
+                logPrintf("Dictionary", "get", LOG_ERROR, "Key '%s' not found", key.c_str());
+                return ExtValue::invalid();
+        }
+        else
+        {
+                if (val)
+                        return *val;
+                return ExtValue::empty();
+        }
 }
 
@@ -422 +432 @@
         }
         *ret = ExtValue();
+}
+
+void DictionaryObject::p_hasKey(PARAMPROCARGS)
+{
+        int found = 0;
+        hash.get(args->getString(), &found);
+        ret->setInt(found);
 }