Changeset 1084 for trunk

Timestamp:

Aug 3, 2008, 11:04:29 PM (16 years ago)

Author:

dkearney

Message:

adding new general purpose dictionary to store void*'s instead of specific objects like RpLibrary?*'s or RpDXWriter*'s
we'll try this out in fortran, matlab and octave bindings

Location:

trunk/src/core

Files:

• RpBindingsDict.cc (modified) (9 diffs)
• RpBindingsDict.h (modified) (2 diffs)

trunk/src/core/RpBindingsDict.cc

@@ -15 +15 @@
 RpDict DICT_TEMPLATE_L ObjDict_Lib;
 RpDict DICT_TEMPLATE_U ObjDictUnits;
+RpDict DICT_TEMPLATE_V ObjDict_Void;
 
 /**********************************************************************/
@@ -35 +36 @@
     int dictKey = key;
     int newEntry = 0;
+    bool ci = false;
 
     if (objectName) {
@@ -45 +47 @@
         }
         long int dictKey_long = dictKey;
-        ObjDict_Lib.set(dictKey_long,objectName,NULL,&newEntry);
+        ObjDict_Lib.set(dictKey_long,objectName,NULL,&newEntry,ci);
         retVal = dictKey;
     }
@@ -94 +96 @@
 void
 cleanLibDict () {
-    // clean up the dictionary
-
     RpDictEntry DICT_TEMPLATE_L *hPtr;
-    // RpDictIterator DICT_TEMPLATE iter(fortObjDict_Lib);
     // should rp_quit clean up the dict or some function in RpBindingsCommon.h
     RpDictIterator DICT_TEMPLATE_L iter(ObjDict_Lib);
@@ -104 +103 @@
 
     while (hPtr) {
-        // Py_DECREF(*(hPtr->getValue()));
         hPtr->erase();
         hPtr = iter.next();
     }
 
-    // if (fortObjDict_Lib.size()) {
     if (ObjDict_Lib.size()) {
         // probably want to change the warning sometime
@@ -135 +132 @@
     int dictNextKey = ObjDictUnits.size() + 1;
     int newEntry = 0;
+    bool ci = false;
 
     if (objectName != "") {
@@ -141 +139 @@
         // the new entry.
         long int dictNextKey_long = dictNextKey;
-        ObjDictUnits.set(dictNextKey_long,objectName, NULL, &newEntry);
+        ObjDictUnits.set(dictNextKey_long,objectName,NULL,&newEntry,ci);
         retVal = dictNextKey;
     }
@@ -189 +187 @@
 void
 cleanUnitsDict () {
-    // clean up the dictionary
-
     RpDictEntry DICT_TEMPLATE_U *hPtr;
     // should rp_quit clean up the dict or some function in RpBindingsCommon.h
@@ -207 +203 @@
     }
 }
+
+/**********************************************************************/
+// FUNCTION: storeObject_Void()
+/// Store an object into the general dictionary.
+/**
+ * This function stores a void* object pointed to by 'objectName'
+ * into the general dictionary. This is helpful for writing bindings
+ * for languages that can not accept pointers to provide back to the
+ * function's caller.
+ *
+ * Returns the key of the object in the dictionary
+ * On Error, returns 0 (which also means nothing can be stored at 0)
+ */
+
+size_t
+storeObject_Void(void* objectName, size_t key) {
+
+    size_t retVal = 0;
+    size_t dictKey = key;
+    int newEntry = 0;
+    bool ci = false;
+
+    if (objectName) {
+        // dictionary returns a reference to the inserted value
+        // no error checking to make sure it was successful in entering
+        // the new entry.
+
+        if (dictKey == 0) {
+            dictKey = ObjDict_Void.size() + 1;
+        }
+        ObjDict_Void.set(dictKey,objectName,NULL,&newEntry,ci);
+        retVal = dictKey;
+    }
+
+    return retVal;
+}
+
+/**********************************************************************/
+// FUNCTION: getObject_Void()
+/// Get an object from the general dictionary.
+/**
+ * This function retrieves the void* object associated with the key
+ * 'objKey' from the general dictionary and returns its address to the
+ * caller. This is helpful for writing bindings for languages that can
+ * not accept pointers to provide back to the function's caller.
+ *
+ * Returns the address of the void* object in the dictionary
+ */
+
+void*
+getObject_Void(size_t objKey) {
+
+    RpDictEntry DICT_TEMPLATE_V* voidEntry = &(ObjDict_Void.getNullEntry());
+    RpDictEntry DICT_TEMPLATE_V* nullEntry = &(ObjDict_Void.getNullEntry());
+
+    voidEntry = &(ObjDict_Void.find(objKey));
+
+    if ( (!voidEntry->isValid()) || (voidEntry == nullEntry) ) {
+        return NULL;
+    }
+
+   return *(voidEntry->getValue());
+
+}
+
+/**********************************************************************/
+// FUNCTION: cleanVoidDict()
+/// Clean the library dictionary, removing all entries in the dictionary
+/**
+ * This function removes all entries from the library dictionary.
+ *
+ * \sa {storeObject_Lib,getObject_Lib}
+ */
+
+void
+cleanVoidDict () {
+    RpDictEntry DICT_TEMPLATE_V *hPtr;
+    // should rp_quit clean up the dict or some function in RpBindingsCommon.h
+    RpDictIterator DICT_TEMPLATE_V iter(ObjDict_Void);
+
+    hPtr = iter.first();
+
+    while (hPtr) {
+        hPtr->erase();
+        hPtr = iter.next();
+    }
+
+    if (ObjDict_Lib.size()) {
+        // probably want to change the warning sometime
+        // printf("\nWARNING: internal dictionary is not empty..deleting\n");
+    }
+
+}
+

trunk/src/core/RpBindingsDict.h

@@ -30 +30 @@
 #define DICT_TEMPLATE_L <long,RpLibrary*>
 #define DICT_TEMPLATE_U <long,std::string>
+#define DICT_TEMPLATE_V <size_t,void*>
 
 // global declaration of library and units dictionaries
@@ -37 +38 @@
 extern RpDict DICT_TEMPLATE_L ObjDict_Lib;
 extern RpDict DICT_TEMPLATE_U ObjDictUnits;
+extern RpDict DICT_TEMPLATE_V ObjDict_Void;
 
 
 int storeObject_Lib(RpLibrary* objectName, int key=0);
 int storeObject_UnitsStr(std::string objectName);
+size_t storeObject_Void(void* objectName, size_t key=0);
 
 RpLibrary* getObject_Lib(int objKey);
 const RpUnits* getObject_UnitsStr(int objKey);
+void* getObject_Void(size_t objKey);
 
 void cleanLibDict();
 void cleanUnitsDict();
+void cleanVoidDict();
 
 #ifdef __cplusplus