Merge pull request #9018 from gadfort/gui-gif-key

gui: default -key to most recent and add additional error checks for array out of bounds

Author: maliberty

src/gui/README.md

@@ -193,7 +193,7 @@ save_animated_gif
 | `-resolution`| resolution in microns per pixel to use when saving the image, default will match what the GUI has selected.|
 | `-width`| width of the output image in pixels, default will be computed from the resolution. Cannot be used with ``-resolution``.|
 | `-delay`| delay between frames in the GIF.|
-| `-key`| used to distinguish multiple GIF files (returned by -add).|
+| `-key`| used to distinguish multiple GIF files (returned by -add). Defaults to the most recent GIF.|
 
 ### Select Objects
 

src/gui/include/gui/gui.h

@@ -827,12 +827,12 @@ class Gui
   // Start returns the key for use by add and end.  This allows multiple
   // gifs to be open at once.
   int gifStart(const std::string& filename);
-  void gifAddFrame(int key,
+  void gifAddFrame(std::optional<int> key,
                    const odb::Rect& region = odb::Rect(),
                    int width_px = 0,
                    double dbu_per_pixel = 0,
                    std::optional<int> delay = {});
-  void gifEnd(int key);
+  void gifEnd(std::optional<int> key);
 
   void setHeatMapSetting(const std::string& name,
                          const std::string& option,

src/gui/src/gui.cpp

@@ -1461,13 +1461,16 @@ int Gui::gifStart(const std::string& filename)
   return gifs_.size() - 1;
 }
 
-void Gui::gifAddFrame(const int key,
+void Gui::gifAddFrame(std::optional<int> key,
                       const odb::Rect& region,
                       int width_px,
                       double dbu_per_pixel,
                       std::optional<int> delay)
 {
-  if (key >= gifs_.size() || gifs_[key] == nullptr) {
+  if (!key.has_value()) {
+    key = gifs_.size() - 1;
+  }
+  if (*key < 0 || *key >= gifs_.size() || gifs_[*key] == nullptr) {
     logger_->warn(utl::GUI, 51, "GIF not active");
     return;
   }
@@ -1476,7 +1479,7 @@ void Gui::gifAddFrame(const int key,
     logger_->error(utl::GUI, 50, "No design loaded.");
   }
 
-  auto& gif = gifs_[key];
+  auto& gif = gifs_[*key];
 
   odb::Rect save_region = region;
   const bool use_die_area = region.dx() == 0 || region.dy() == 0;
@@ -1549,14 +1552,17 @@ void Gui::gifAddFrame(const int key,
                 delay.value_or(kDefaultGifDelay));
 }
 
-void Gui::gifEnd(const int key)
+void Gui::gifEnd(std::optional<int> key)
 {
-  if (key >= gifs_.size() || gifs_[key] == nullptr) {
+  if (!key.has_value()) {
+    key = gifs_.size() - 1;
+  }
+  if (*key < 0 || *key >= gifs_.size() || gifs_[*key] == nullptr) {
     logger_->warn(utl::GUI, 58, "GIF not active");
     return;
   }
 
-  auto& gif = gifs_[key];
+  auto& gif = gifs_[*key];
   if (gif->writer == nullptr) {
     logger_->warn(utl::GUI,
                   107,
@@ -1567,7 +1573,7 @@ void Gui::gifEnd(const int key)
   }
 
   GifEnd(gif->writer.get());
-  gifs_[key] = nullptr;
+  gifs_[*key] = nullptr;
 }
 
 class SafeApplication : public QApplication

src/gui/src/gui.i

@@ -836,16 +836,24 @@ void gif_add(int key, double xlo, double ylo, double xhi, double yhi, int width_
   if (delay > 0) {
     delay_pass = delay;
   }
-  gui->gifAddFrame(key, make_rect(xlo, ylo, xhi, yhi), width_px, dbu_per_pixel, delay_pass);
+  std::optional<int> key_pass;
+  if (key >= 0) {
+    key_pass = key;
+  }
+  gui->gifAddFrame(key_pass, make_rect(xlo, ylo, xhi, yhi), width_px, dbu_per_pixel, delay_pass);
 }
 
 void gif_end(int key)
 {
   if (!check_gui("gif_end")) {
     return;
   }
+  std::optional<int> key_pass;
+  if (key >= 0) {
+    key_pass = key;
+  }
   auto gui = gui::Gui::get();
-  gui->gifEnd(key);
+  gui->gifEnd(key_pass);
 }
 
 %} // inline

src/gui/src/gui.tcl

@@ -190,7 +190,7 @@ proc save_animated_gif { args } {
     set delay $keys(-delay)
   }
 
-  set key 0
+  set key -1
   if { [info exists keys(-key)] } {
     set key $keys(-key)
   }

src/gui/src/stub.cpp

@@ -209,11 +209,11 @@ int Gui::gifStart(const std::string& filename)
   return 0;
 }
 
-void Gui::gifEnd(const int key)
+void Gui::gifEnd(std::optional<int> key)
 {
 }
 
-void Gui::gifAddFrame(const int key,
+void Gui::gifAddFrame(std::optional<int> key,
                       const odb::Rect& region,
                       int width_px,
                       double dbu_per_pixel,