refactor readobject.c

This undertakes a slightly more invasive refactor of readobject.

Author: JakeOShannessy

Source/shared/readobject.c

@@ -371,33 +371,41 @@ typedef struct {
   sv_object object_def_last;
   /** @brief A number of standard objects to be used. */
   std_objects std_object_defs;
+  int iavatar_types;
+  int navatar_types;
+  sv_object **avatar_types;
+  sv_object *avatar_defs_backup[2];
 } object_collection;
 
 /**
- * @brief Initialise an @ref object_collection and avatar types.
+ * @brief Initialise an @ref object_collection.
+ *
+ * @returns A @ref object_collection which has been properly initialized.
+ */
+object_collection *CreateObjectCollection(void);
+
+/**
+ * @brief Read objects from the standard file locations, using fallback objects
+ * if object definitions are not found.
  *
  * @param[inout] objectscoll Pointer to the location of the @ref
- * object_collection to initialize.
- * @param[in] setbw Set the colors to black and white.
- * @param[inout] avatar_types Linked-list of avatar types. TODO: include in
- * object_collection.
- * @param[in] avatar_defs_backup Backup avatar types. TODO: include in
- * object_collection.
+ * object_collection to read object definitions into. This @ref
+ * object_collection
  * @param[in] smokeview_bindir The path which contains the smokeview binary.
- * Object definition files from this directory are read.
+ * Object definition files from this directory are read. If NULL, this step is
+ * skipped.
  * @param[in] setbw Set the colors to black and white.
  * @param[in] fdsprefix The fdsprefix. This is used to find case-specific object
- * files (e.g., "${fdsprefix}.svo").
+ * files (e.g., "${fdsprefix}.svo"). If NULL, such files are never read.
  * @param[in] isZoneFireModel Is this model a zone fire model.
  */
-void InitObjectCollection(object_collection *objectscoll, int navatar_types,
-                          sv_object **avatar_types,
-                          sv_object *avatar_defs_backup[2],
-                          const char *smokeview_bindir, const char *fdsprefix,
-                          int setbw, int isZoneFireModel);
+void ReadDefaultObjectCollection(object_collection *objectscoll,
+                                 const char *smokeview_bindir,
+                                 const char *fdsprefix, int setbw,
+                                 int isZoneFireModel);
 /**
- * @brief Free an @ref object_collection previously initialized by @ref
- * InitObjectCollection.
+ * @brief Free an @ref object_collection previously created by @ref
+ * CreateObjectCollection.
  *
  * @param[inout] objectscoll The @ref object_collection to free.
  */
@@ -424,7 +432,18 @@ sv_object *GetSmvObject(object_collection *objectscoll, char *label);
  */
 sv_object *GetSmvObjectType(object_collection *objectscoll, char *olabel,
                             sv_object *default_object);
-
+/**
+ * @brief Read in object definitions from an object file and add them to an
+ * object collection.
+ *
+ * @param[inout] nobject_defs The number of object definitions in object_defs
+ * @param[in] file The file path to read from
+ * @param[out] setbw A boolean value to set wether these objects should be set
+ * to black and white
+ *
+ * @returns The number of objects read
+ */
+int ReadObjectDefs(object_collection *objectscoll, const char *file, int setbw);
 // END MAIN API
 
 // These still need to be documented.

Source/shared/readobject.h

@@ -3823,15 +3823,15 @@ void DrawSmvObject(sv_object *object_dev, int iframe_local, propdata *prop, int
     object = object_dev;
   }
   if(object->visible == 0 && vis_override == 0)return;
-  if(object == objectscoll.std_object_defs.missing_device&&show_missing_objects == 0)return;
+  if(object == objectscoll->std_object_defs.missing_device&&show_missing_objects == 0)return;
   if(iframe_local > object->nframes - 1 || iframe_local < 0)iframe_local = 0;
   framei = object->obj_frames[iframe_local];
 
   assert(framei->error == 0 || framei->error == 1);
 
   if(framei->error == 1){
-    object = objectscoll.std_object_defs.error_device;
-    framei = objectscoll.std_object_defs.error_device->obj_frames[0];
+    object = objectscoll->std_object_defs.error_device;
+    framei = objectscoll->std_object_defs.error_device->obj_frames[0];
     prop = NULL;
   }
 
@@ -4059,7 +4059,7 @@ void DrawSmvObject(sv_object *object_dev, int iframe_local, propdata *prop, int
           iframe_local2 = 0;
         }
         object_name = (toki - 1)->string;
-        included_object = GetSmvObjectType(&objectscoll, object_name, objectscoll.std_object_defs.missing_device);
+        included_object = GetSmvObjectType(objectscoll, object_name, objectscoll->std_object_defs.missing_device);
         toki->included_frame = iframe_local2;
         toki->included_object = included_object;
       }
@@ -5863,10 +5863,10 @@ void InitializeDeviceCsvData(int flag){
 void UpdateObjectUsed(void){
   int i;
 
-  for(i = 0; i<objectscoll.nobject_defs; i++){
+  for(i = 0; i<objectscoll->nobject_defs; i++){
     sv_object *obj_typei;
 
-    obj_typei = objectscoll.object_defs[i];
+    obj_typei = objectscoll->object_defs[i];
     obj_typei->used_by_device = 0;
   }
   for(i = 0; i<ndeviceinfo; i++){

Source/smokeview/IOobjects.c

@@ -396,7 +396,7 @@ void DrawTours(void){
 
           glRotatef(az_angle,0.0,0.0,1.0);
 
-          DrawSmvObject(avatar_types[touri->glui_avatar_index],0,NULL,0,NULL,0);
+          DrawSmvObject(objectscoll->avatar_types[touri->glui_avatar_index],0,NULL,0,NULL,0);
           glPopMatrix();
         }
         break;

Source/smokeview/IOtour.c

@@ -943,8 +943,8 @@ void SurfacesHideAll() {
 }
 
 void DevicesHideAll() {
-  for (size_t i = 0; i < objectscoll.nobject_defs; i++) {
-    sv_object *objecti = objectscoll.object_defs[i];
+  for (size_t i = 0; i < objectscoll->nobject_defs; i++) {
+    sv_object *objecti = objectscoll->object_defs[i];
     objecti->visible = 0;
   }
 }
@@ -3664,13 +3664,13 @@ int SetShowdevices(int ndevices_ini, const char *const *names) {
 
   char tempname[255]; // temporary buffer to convert from const string
 
-  for (size_t i = 0; i < objectscoll.nobject_defs; i++) {
-    obj_typei = objectscoll.object_defs[i];
+  for (size_t i = 0; i < objectscoll->nobject_defs; i++) {
+    obj_typei = objectscoll->object_defs[i];
     obj_typei->visible = 0;
   }
   for (size_t i = 0; i < ndevices_ini; i++) {
     strncpy(tempname, names[i], 255 - 1); // use temp buffer
-    obj_typei = GetSmvObject(&objectscoll, tempname);
+    obj_typei = GetSmvObject(objectscoll, tempname);
     // obj_typei = GetSmvObject(names[i]);
     if (obj_typei != NULL) {
       obj_typei->visible = 1;

Source/smokeview/c_api.c

@@ -777,7 +777,7 @@ int ColorbarClick(int x, int y){
   return_val = HandleColorbarIndex(colorbar_index);
   return return_val;
 }
-  
+
   /* ------------------ GetTimeBarFrame ------------------------ */
 
 int GetTimeBarFrame(int xm){
@@ -1969,14 +1969,14 @@ void Keyboard(unsigned char key, int flag){
       break;
     case 'i':
       if(keystate==GLUT_ACTIVE_ALT){ // toggle device visibility
-        if(objectscoll.nobject_defs>0){
+        if(objectscoll->nobject_defs>0){
           int vis;
 
-          vis = 1-objectscoll.object_defs[0]->visible;
-          for(i = 0; i<objectscoll.nobject_defs; i++){
+          vis = 1-objectscoll->object_defs[0]->visible;
+          for(i = 0; i<objectscoll->nobject_defs; i++){
             sv_object *objecti;
 
-            objecti = objectscoll.object_defs[i];
+            objecti = objectscoll->object_defs[i];
             objecti->visible = vis;
           }
           updatemenu = 1;
@@ -2016,23 +2016,23 @@ void Keyboard(unsigned char key, int flag){
           devicei->selected = selected;
         }
       }
-      if(objectscoll.nobject_defs>0){
+      if(objectscoll->nobject_defs>0){
         int makevis=1;
 
-        for(i = 0; i<objectscoll.nobject_defs; i++){
+        for(i = 0; i<objectscoll->nobject_defs; i++){
           sv_object *objecti;
 
-          objecti = objectscoll.object_defs[i];
+          objecti = objectscoll->object_defs[i];
           if(objecti->visible==1){
             makevis = 0;
             break;
           }
         }
         if(makevis==1){
-          for(i = 0; i<objectscoll.nobject_defs; i++){
+          for(i = 0; i<objectscoll->nobject_defs; i++){
             sv_object *objecti;
 
-            objecti = objectscoll.object_defs[i];
+            objecti = objectscoll->object_defs[i];
             objecti->visible = 1;
           }
         }

Source/smokeview/callbacks.c

@@ -2,6 +2,7 @@
 
 #include <stdio.h>
 #include <string.h>
+
 #include GLUT_H
 #include <math.h>
 

Source/smokeview/colortable.c

@@ -254,11 +254,11 @@ extern "C" void GLUITourSetup(int main_window){
   glui_tour->add_spinner_to_panel(PANEL_path, _("points"),     GLUI_SPINNER_INT,   &tour_ntimes, VIEW_times, TourCB);
   PANEL_misc = glui_tour->add_panel_to_panel(ROLLOUT_settings, "Misc", true);
   CHECKBOX_showintermediate = glui_tour->add_checkbox_to_panel(PANEL_misc, _("Show intermediate path nodes"), &show_path_knots);
-  if(navatar_types > 0){
+  if(objectscoll->navatar_types > 0){
     glui_tour->add_checkbox_to_panel(PANEL_misc, _("Show avatar"), &show_avatar);
     LISTBOX_avatar = glui_tour->add_listbox_to_panel(PANEL_misc, _("Avatar:"), &glui_avatar_index, TOUR_AVATAR, TourCB);
-    for(i = 0;i < navatar_types;i++){
-      LISTBOX_avatar->add_item(i, avatar_types[i]->label);
+    for(i = 0;i < objectscoll->navatar_types;i++){
+      LISTBOX_avatar->add_item(i, objectscoll->avatar_types[i]->label);
     }
     if(tourlocus_type == 0){
       glui_avatar_index = -1;
@@ -267,7 +267,7 @@ extern "C" void GLUITourSetup(int main_window){
       glui_avatar_index = -2;
     }
     else{
-      glui_avatar_index = iavatar_types;
+      glui_avatar_index = objectscoll->iavatar_types;
     }
     LISTBOX_avatar->set_int_val(glui_avatar_index);
   }
@@ -690,7 +690,7 @@ void TourCB(int var){
     if(selected_tour->glui_avatar_index!=glui_avatar_index){
       selected_tour->glui_avatar_index=glui_avatar_index;
 // hack to make touring avatar show up
-      avatar_types[glui_avatar_index]->visible=1;
+      objectscoll->avatar_types[glui_avatar_index]->visible=1;
       updatemenu=1;
     }
     if(glui_avatar_index==-1){
@@ -701,7 +701,7 @@ void TourCB(int var){
     }
     else{
       tourlocus_type=2;
-      iavatar_types=glui_avatar_index;
+      objectscoll->iavatar_types=glui_avatar_index;
     }
     break;
   case TOUR_UPDATELABEL:

Source/smokeview/glui_tour.cpp

@@ -944,5 +944,6 @@ int main(int argc, char **argv){
   PRINTF("Startup time: %.1f s\n", startup_time);
 
   glutMainLoop();
+  FreeVars();
   return 0;
 }