Fix incorrect handling of invalid arg exception in commands

 - Expose interactor::invalid_args exception so it can be reused
 - Update usages
 - Catch generic exception when using commands in console
 - Use interactor::invalid_arg in commands in application

Author: mwestphal

application/F3DStarter.cxx

@@ -1072,7 +1072,13 @@ int F3DStarter::Start(int argc, char** argv)
         {
           if (!command.empty())
           {
-            interactor.triggerCommand(command);
+            // XXX: No need to catch interactor::command_runtime_exception
+            // as neither libf3d nor F3D has command that can trigger it
+            if (!interactor.triggerCommand(command))
+            {
+              f3d::log::error("Error in command script, stopping script execution");
+              break;
+            }
           }
         }
         scriptFile.close();
@@ -1732,8 +1738,9 @@ void F3DStarter::AddCommands()
     }
     if (args.size() != 1)
     {
-      throw std::invalid_argument{ std::string("Command: ") + std::string(commandName) +
-        " takes at most 1 argument, got " + std::to_string(args.size()) + " arguments instead." };
+      throw f3d::interactor::invalid_args_exception(std::string("Command: ") +
+        std::string(commandName) + " takes at most 1 argument, got " + std::to_string(args.size()) +
+        " arguments instead.");
     }
     return f3d::options::parse<bool>(args[0]);
   };

library/private/interactor_impl.h

@@ -118,16 +118,6 @@ class interactor_impl : public interactor
    */
   void SetCommandBuffer(const char* command);
 
-  /**
-   * An exception that can be thrown by certain command callbacks
-   * when the arguments of the callback are incorrect and expected
-   * to be caught by triggerCommand
-   */
-  struct invalid_args_exception : public exception
-  {
-    explicit invalid_args_exception(const std::string& what = "");
-  };
-
 private:
   class internals;
   std::unique_ptr<internals> Internals;

library/public/interactor.h

@@ -100,8 +100,9 @@ class F3D_EXPORT interactor
    *
    * Return true if the command succeeded, false otherwise.
    * Throw an interactor::command_runtime_exception if the command callback
-   * throw an unrecognized exception. Note that default commands cannot throw such
-   * an exception.
+   * throw an unrecognized exception.
+   * Note that default commands will never throw this exception, but adding commands
+   * without exception catching may trigger this behavior.
    */
   virtual bool triggerCommand(std::string_view command) = 0;
   ///@}
@@ -282,6 +283,19 @@ class F3D_EXPORT interactor
     explicit command_runtime_exception(const std::string& what = "");
   };
 
+  /**
+   * An exception that can be thrown by command callbacks
+   * when the arguments of the callback are incorrect.
+   * This exception is caught by triggerCommand and logged.
+   */
+  struct invalid_args_exception : public exception
+  {
+    explicit invalid_args_exception(const std::string& what = "")
+      : exception(what)
+    {
+    }
+  };
+
 protected:
   //! @cond
   interactor() = default;

library/src/interactor_impl.cxx

@@ -471,7 +471,7 @@ class interactor_impl::internals
         try
         {
           // XXX: Ignore the boolean return of triggerCommand,
-          //  error is already logged by triggerCommand
+          // error is already logged by triggerCommand
           this->Interactor.triggerCommand(commandWithArgs);
         }
         catch (const f3d::interactor::command_runtime_exception& ex)
@@ -538,7 +538,17 @@ class interactor_impl::internals
 
     if (this->CommandBuffer.has_value())
     {
-      this->Interactor.triggerCommand(this->CommandBuffer.value());
+      try
+      {
+        // XXX: Ignore the boolean return of triggerCommand,
+        // error is already logged by triggerCommand
+        this->Interactor.triggerCommand(this->CommandBuffer.value());
+      }
+      catch (const f3d::interactor::command_runtime_exception& ex)
+      {
+        log::error("Interaction: error running command: \"" + this->CommandBuffer.value() +
+          "\": " + ex.what());
+      }
       this->CommandBuffer.reset();
     }
 
@@ -622,8 +632,8 @@ interactor& interactor_impl::initCommands()
   {
     if (args.size() != expectedSize)
     {
-      throw interactor_impl::invalid_args_exception(std::string("Command: ") +
-        std::string(actionName) + " is expecting " + std::to_string(expectedSize) + " arguments");
+      throw interactor::invalid_args_exception(std::string("Command: ") + std::string(actionName) +
+        " is expecting " + std::to_string(expectedSize) + " arguments");
     }
   };
 
@@ -705,9 +715,8 @@ interactor& interactor_impl::initCommands()
       }
       else
       {
-        throw interactor_impl::invalid_args_exception(
-          std::string("Command: cycle_coloring arg:\"") + std::string(type) +
-          "\" is not recognized.");
+        throw interactor::invalid_args_exception(std::string("Command: cycle_coloring arg:\"") +
+          std::string(type) + "\" is not recognized.");
       }
       this->Internals->SynchronizeScivisOptions(this->Internals->Options, ren);
       this->Internals->Window.PrintColoringDescription(log::VerboseLevel::DEBUG);
@@ -782,7 +791,7 @@ interactor& interactor_impl::initCommands()
       }
       else
       {
-        throw interactor_impl::invalid_args_exception(
+        throw interactor::invalid_args_exception(
           std::string("Command: set_camera arg:\"") + std::string(type) + "\" is not recognized.");
       }
     });
@@ -819,8 +828,7 @@ interactor& interactor_impl::initCommands()
     {
       if (args.size() < 2)
       {
-        throw interactor_impl::invalid_args_exception(
-          "alias command requires at least 2 arguments");
+        throw interactor::invalid_args_exception("alias command requires at least 2 arguments");
       }
 
       // Validate the alias arguments
@@ -932,7 +940,7 @@ bool interactor_impl::triggerCommand(std::string_view command)
     log::error("Command: provided args in command: \"", command,
       "\" cannot be parsed into an option, ignoring");
   }
-  catch (const invalid_args_exception& ex)
+  catch (const interactor::invalid_args_exception& ex)
   {
     log::error(ex.what(), " Ignoring.");
   }
@@ -1371,10 +1379,4 @@ void interactor_impl::SetCommandBuffer(const char* command)
   // XXX This replace previous command buffer, it should be improved
   this->Internals->CommandBuffer = command;
 }
-
-//----------------------------------------------------------------------------
-interactor_impl::invalid_args_exception::invalid_args_exception(const std::string& what)
-  : exception(what)
-{
-}
 }