wxruby3 0.9.0.pre.rc.3 → 0.9.1

data/rakelib/lib/core/include/funcall.inc

@@ -1,3 +1,6 @@
+// Copyright (c) 2023 M.J.N. Corino, The Netherlands
+//
+// This software is released under the MIT license.
 
 #undef _
 
@@ -8,58 +11,22 @@
 
 typedef VALUE (*RUBY_INVOKE_FUNC) (VALUE);
 
-namespace Swig {
-  /* Base class for director exceptions */
-  class DirectorException : public std::exception
-  {
-  protected:
-    VALUE swig_error;
-    std::string swig_msg;
-  protected:
-    DirectorException(VALUE error) : swig_error(error) { }
-    DirectorException(VALUE error, const char *hdr, const char *msg ="") : swig_error(error), swig_msg(hdr)
-    {
-      if (msg[0])
-      {
-        swig_msg += " ";
-        swig_msg += msg;
-      }
-      if (swig_msg.size())
-      {
-        VALUE str = rb_str_new(swig_msg.data(), swig_msg.size());
-        swig_error = rb_exc_new3(error, str);
-      }
-      else
-      {
-        swig_error = error;
-      }
-    }
-  public:
-    virtual ~DirectorException() throw() { }
-    VALUE getType() const
-    {
-      return CLASS_OF(swig_error);
-    }
-    VALUE getError() const
-    {
-      return swig_error;
-    }
-    /* Deprecated, use what() instead */
-    const std::string& getMessage() const
-    {
-      return swig_msg;
-    }
-    const char *what() const throw()
-    {
-      return swig_msg.c_str();
-    }
-  };
+VALUE rb_exc_set_backtrace(VALUE, VALUE);
+VALUE rb_get_backtrace(VALUE);
+
+namespace Swig
+{
   class DirectorRubyException : public DirectorException
   {
   public:
-    DirectorRubyException(const char *exname, const char *msg="")
-      : DirectorException(rb_eRuntimeError, exname, msg)
+    DirectorRubyException(VALUE error, VALUE rcvr, ID fn_id)
+      : DirectorException(Qnil)
     {
+      VALUE msg = rb_sprintf("Caught exception in SWIG director method for %s#%s", rb_class2name(CLASS_OF(rcvr)), rb_id2name(fn_id));
+      this->swig_msg = StringValuePtr(msg);
+      swig_error = rb_exc_new_str(rb_eRuntimeError, msg);
+      VALUE bt = rb_funcall(error, rb_intern("backtrace"), 0);
+      rb_funcall(swig_error, rb_intern("set_backtrace"), 1, bt);
     }
   };
 }
@@ -96,15 +63,18 @@ public:
 
   bool has_caught_exception () { return this->ex_caught_; }
 
-  VALUE get_exception () { return rb_gv_get ("$!"); }
+  VALUE get_exception () { return rb_errinfo(); }
 
   ID id () { return this->fn_id_; }
 
 protected:
   struct FuncArgs
   {
+    FuncArgs(VALUE rcvr) : receiver_(rcvr) {}
     virtual ~FuncArgs () {}
     virtual VALUE rb_invoke (ID fnid) const = 0;
+
+    VALUE receiver_;
   };
 
   VALUE _invoke (const FuncArgs& fa)
@@ -122,10 +92,7 @@ protected:
       {
         // handle exception
         VALUE rexc = this->get_exception ();
-        VALUE msg = rb_eval_string ("$!.message+\"\\n\"+$!.backtrace.join(\"\\n\")");
-        const char *exc_name = rb_obj_classname(rexc);
-        wxLogDebug("%s : %s", exc_name, StringValuePtr(msg));
-        throw Swig::DirectorRubyException(exc_name, StringValuePtr(msg));
+        throw Swig::DirectorRubyException(rexc, fa.receiver_, this->fn_id_);
       }
       else
       {
@@ -142,7 +109,7 @@ protected:
   struct FuncArgArray : public FuncArgs
   {
     FuncArgArray (VALUE rcvr, VALUE args)
-     : receiver_ (rcvr), args_ (args) {}
+     : FuncArgs (rcvr), args_ (args) {}
     virtual ~FuncArgArray () {}
 
     virtual VALUE rb_invoke (ID fnid) const
@@ -150,14 +117,13 @@ protected:
       return rb_apply (this->receiver_, fnid, this->args_);
     }
 
-    VALUE receiver_;
     VALUE args_;
   };
 
   struct FuncArgList : public FuncArgs
   {
     FuncArgList (VALUE rcvr, int argc, VALUE* args)
-     : receiver_ (rcvr), argc_ (argc), args_ (args) {}
+     : FuncArgs (rcvr), argc_ (argc), args_ (args) {}
     virtual ~FuncArgList () {}
 
     virtual VALUE rb_invoke (ID fnid) const
@@ -165,7 +131,6 @@ protected:
       return rb_funcall2 (this->receiver_, fnid, this->argc_, this->args_);
     }
 
-    VALUE receiver_;
     int argc_;
     VALUE* args_;
   };

data/rakelib/lib/core/include/init.inc

@@ -1,3 +1,6 @@
+// Copyright (c) 2023 M.J.N. Corino, The Netherlands
+//
+// This software is released under the MIT license.
 
 #ifdef __WXMSW__
 

data/rakelib/lib/core/include/swigdirector.inc

@@ -0,0 +1,384 @@
+// Copyright (c) 2023 M.J.N. Corino, The Netherlands
+//
+// This software is released under the MIT license.
+
+// SWIG director classes
+
+#include <string>
+#include <iostream>
+#include <exception>
+#include <map>
+
+namespace Swig
+{
+
+  /* memory handler */
+  struct WXRB_EXPORT_FLAG GCItem
+  {
+    virtual ~GCItem();
+
+    virtual swig_ruby_owntype get_own() const;
+  };
+
+  GCItem::~GCItem() {}
+
+  swig_ruby_owntype GCItem::get_own() const
+  {
+    swig_ruby_owntype own = {0, 0};
+    return own;
+  }
+
+  struct WXRB_EXPORT_FLAG GCItem_var
+  {
+    GCItem_var(GCItem *item = 0) : _item(item) {}
+
+    GCItem_var& operator=(GCItem *item);
+
+    ~GCItem_var()
+    {
+      delete _item;
+    }
+
+    GCItem *operator->() const
+    {
+      return _item;
+    }
+
+  private:
+    GCItem *_item;
+  };
+
+  GCItem_var& GCItem_var::operator=(GCItem *item)
+  {
+    GCItem *tmp = _item;
+    _item = item;
+    delete tmp;
+    return *this;
+  }
+
+  template <typename Type>
+  struct GCItem_T : GCItem
+  {
+    GCItem_T(Type *ptr) : _ptr(ptr) {}
+
+    virtual ~GCItem_T()
+    {
+      delete _ptr;
+    }
+
+  private:
+    Type *_ptr;
+  };
+
+  struct WXRB_EXPORT_FLAG GCItem_Object : GCItem
+  {
+    GCItem_Object(swig_ruby_owntype own) : _own(own) {}
+
+    virtual ~GCItem_Object() {}
+
+    swig_ruby_owntype get_own() const
+    {
+      return _own;
+    }
+
+  private:
+    swig_ruby_owntype _own;
+  };
+
+  template <typename Type>
+  struct GCArray_T : GCItem
+  {
+    GCArray_T(Type *ptr) : _ptr(ptr) {}
+
+    virtual ~GCArray_T()
+    {
+      delete[] _ptr;
+    }
+
+  private:
+    Type *_ptr;
+  };
+
+  /* body args */
+  struct body_args
+  {
+    VALUE recv;
+    ID id;
+    int argc;
+    VALUE *argv;
+  };
+
+  /* Base class for director exceptions */
+  class WXRB_EXPORT_FLAG DirectorException : public std::exception
+  {
+  protected:
+    VALUE swig_error;
+    std::string swig_msg;
+  protected:
+    DirectorException(VALUE error) : swig_error(error) {}
+
+    DirectorException(VALUE error, const char *hdr, const char *msg ="");
+
+    void setup_error(VALUE error);
+
+  public:
+    virtual ~DirectorException() throw();
+
+    VALUE getType() const
+    {
+      return CLASS_OF(swig_error);
+    }
+
+    VALUE getError() const
+    {
+      return swig_error;
+    }
+
+    /* Deprecated, use what() instead */
+    const std::string& getMessage() const
+    {
+      return swig_msg;
+    }
+
+    const char *what() const throw()
+    {
+      return swig_msg.c_str();
+    }
+  };
+
+  DirectorException::DirectorException(VALUE error, const char *hdr, const char *msg)
+    : swig_msg(hdr)
+  {
+    if (msg[0])
+    {
+      swig_msg += " ";
+      swig_msg += msg;
+    }
+    this->setup_error(error);
+  }
+
+  DirectorException::~DirectorException() throw()
+  {}
+
+
+  void DirectorException::setup_error(VALUE error)
+  {
+    if (swig_msg.size())
+    {
+      VALUE str = rb_str_new(swig_msg.data(), swig_msg.size());
+      swig_error = rb_exc_new3(error, str);
+    }
+    else
+    {
+      swig_error = error;
+    }
+  }
+
+  /* Type mismatch in the return value from a Ruby method call */
+  class WXRB_EXPORT_FLAG DirectorTypeMismatchException : public DirectorException
+  {
+  public:
+    DirectorTypeMismatchException(VALUE error, const char *msg="")
+      : DirectorException(error, "SWIG director type mismatch", msg)
+    {}
+
+    DirectorTypeMismatchException(const char *msg="")
+      : DirectorException(rb_eTypeError, "SWIG director type mismatch", msg)
+    {}
+
+    DirectorTypeMismatchException(VALUE self, const char *method, VALUE error, const char *msg="");
+
+    static inline void raise(VALUE error, const char *msg)
+    {
+      throw DirectorTypeMismatchException(error, msg);
+    }
+
+    static inline void raise(const char *msg)
+    {
+      throw DirectorTypeMismatchException(msg);
+    }
+
+    static inline void raise(VALUE self, const char* method, VALUE error, const char *msg)
+    {
+      throw DirectorTypeMismatchException(self, method, error, msg);
+    }
+  };
+
+
+  DirectorTypeMismatchException::DirectorTypeMismatchException(VALUE self, const char *method, VALUE error, const char *msg)
+    : DirectorException(Qnil)
+  {
+    this->swig_msg = "SWIG director type mismatch ";
+    this->swig_msg += msg;
+    this->swig_msg += " returned from ";
+    this->swig_msg += rb_class2name(CLASS_OF(self));
+    this->swig_msg += "#";
+    this->swig_msg += method;
+    this->setup_error(rb_eTypeError);
+  }
+
+  /* Any Ruby exception that occurs during a director method call */
+  class WXRB_EXPORT_FLAG DirectorMethodException : public DirectorException
+  {
+  public:
+    DirectorMethodException(VALUE error)
+      : DirectorException(error)
+    {}
+
+    DirectorMethodException(const char *msg = "")
+      : DirectorException(rb_eRuntimeError, "SWIG director method error.", msg)
+    {}
+
+    static void raise(VALUE error)
+    {
+      throw DirectorMethodException(error);
+    }
+  };
+
+  /* Attempted to call a pure virtual method via a director method */
+  class WXRB_EXPORT_FLAG DirectorPureVirtualException : public DirectorException
+  {
+  public:
+    DirectorPureVirtualException(const char *msg = "")
+      : DirectorException(rb_eRuntimeError, "SWIG director pure virtual method called", msg)
+    {}
+
+    static void raise(const char *msg)
+    {
+      throw DirectorPureVirtualException(msg);
+    }
+  };
+
+  /* Simple thread abstraction for pthreads on win32 */
+#ifdef __THREAD__
+# define __PTHREAD__
+# if defined(_WIN32) || defined(__WIN32__)
+#  define pthread_mutex_lock EnterCriticalSection
+#  define pthread_mutex_unlock LeaveCriticalSection
+#  define pthread_mutex_t CRITICAL_SECTION
+#  define SWIG_MUTEX_INIT(var) var
+# else
+#  include <pthread.h>
+#  define SWIG_MUTEX_INIT(var) var = PTHREAD_MUTEX_INITIALIZER
+# endif
+#endif
+
+#ifdef  __PTHREAD__
+  struct Guard
+  {
+    pthread_mutex_t *_mutex;
+
+    Guard(pthread_mutex_t &mutex) : _mutex(&mutex)
+    {
+      pthread_mutex_lock(_mutex);
+    }
+
+    ~Guard()
+    {
+      pthread_mutex_unlock(_mutex);
+    }
+  };
+# define SWIG_GUARD(mutex) Guard _guard(mutex)
+#else
+# define SWIG_GUARD(mutex)
+#endif
+
+  /* director base class */
+  class WXRB_EXPORT_FLAG Director
+  {
+  private:
+    /* pointer to the wrapped Ruby object */
+    VALUE swig_self;
+    /* flag indicating whether the object is owned by Ruby or c++ */
+    mutable bool swig_disown_flag;
+
+  public:
+    /* wrap a Ruby object. */
+    Director(VALUE self);
+
+    /* discard our reference at destruction */
+    virtual ~Director();
+
+    /* return a pointer to the wrapped Ruby object */
+    VALUE swig_get_self() const
+    {
+      return swig_self;
+    }
+
+    /* acquire ownership of the wrapped Ruby object (the sense of "disown" is from Ruby) */
+    void swig_disown() const
+    {
+      if (!swig_disown_flag)
+      {
+        swig_disown_flag = true;
+      }
+    }
+
+  /* ownership management */
+  private:
+    typedef std::map<void *, GCItem_var> swig_ownership_map;
+    mutable swig_ownership_map swig_owner;
+#ifdef __PTHREAD__
+    static pthread_mutex_t swig_mutex_own;
+#endif
+
+  public:
+    template <typename Type>
+    void swig_acquire_ownership_array(Type *vptr) const
+    {
+      if (vptr)
+      {
+        SWIG_GUARD(swig_mutex_own);
+        swig_owner[vptr] = new GCArray_T<Type>(vptr);
+      }
+    }
+
+    template <typename Type>
+    void swig_acquire_ownership(Type *vptr)  const
+    {
+      if (vptr)
+      {
+        SWIG_GUARD(swig_mutex_own);
+        swig_owner[vptr] = new GCItem_T<Type>(vptr);
+      }
+    }
+
+    void swig_acquire_ownership_obj(void *vptr, swig_ruby_owntype own) const;
+
+    swig_ruby_owntype swig_release_ownership(void *vptr) const;
+  };
+
+  Director::Director(VALUE self)
+    : swig_self(self), swig_disown_flag(false)
+  {}
+
+  /* discard our reference at destruction */
+  Director::~Director()
+  {}
+
+  void Director::swig_acquire_ownership_obj(void *vptr, swig_ruby_owntype own) const
+  {
+    if (vptr && own.datafree)
+    {
+      SWIG_GUARD(swig_mutex_own);
+      swig_owner[vptr] = new GCItem_Object(own);
+    }
+  }
+
+  swig_ruby_owntype Director::swig_release_ownership(void *vptr) const
+  {
+    swig_ruby_owntype own = {0, 0};
+    if (vptr)
+    {
+      SWIG_GUARD(swig_mutex_own);
+      swig_ownership_map::iterator iter = swig_owner.find(vptr);
+      if (iter != swig_owner.end())
+      {
+        own.datafree = iter->second->get_own().datafree;
+        swig_owner.erase(iter);
+      }
+    }
+    return own;
+  }
+
+}

data/rakelib/lib/core/include/swigrubyerrors.inc

@@ -0,0 +1,161 @@
+// Copyright (c) 2023 M.J.N. Corino, The Netherlands
+//
+// This software is released under the MIT license.
+
+// SWIG Ruby error handling
+
+/* Define some additional error types */
+#define SWIG_ObjectPreviouslyDeletedError  -100
+
+
+/* Define custom exceptions for errors that do not map to existing Ruby
+   exceptions.  Note this only works for C++ since a global cannot be
+   initialized by a function in C.  For C, fallback to rb_eRuntimeError.*/
+
+WXRB_EXPORT_FLAG VALUE
+getNullReferenceError(void)
+{
+  static int init = 0;
+  static VALUE rb_eNullReferenceError ;
+  if (!init)
+  {
+    init = 1;
+    rb_eNullReferenceError = rb_define_class("NullReferenceError", rb_eRuntimeError);
+  }
+  return rb_eNullReferenceError;
+}
+
+WXRB_EXPORT_FLAG VALUE
+getObjectPreviouslyDeletedError(void)
+{
+  static int init = 0;
+  static VALUE rb_eObjectPreviouslyDeleted ;
+  if (!init)
+  {
+    init = 1;
+    rb_eObjectPreviouslyDeleted = rb_define_class("ObjectPreviouslyDeleted", rb_eRuntimeError);
+  }
+  return rb_eObjectPreviouslyDeleted;
+}
+
+
+WXRB_EXPORT_FLAG VALUE
+SWIG_Ruby_ErrorType(int SWIG_code)
+{
+  VALUE type;
+  switch (SWIG_code)
+  {
+  case SWIG_MemoryError:
+    type = rb_eNoMemError;
+    break;
+  case SWIG_IOError:
+    type = rb_eIOError;
+    break;
+  case SWIG_RuntimeError:
+    type = rb_eRuntimeError;
+    break;
+  case SWIG_IndexError:
+    type = rb_eIndexError;
+    break;
+  case SWIG_TypeError:
+    type = rb_eTypeError;
+    break;
+  case SWIG_DivisionByZero:
+    type = rb_eZeroDivError;
+    break;
+  case SWIG_OverflowError:
+    type = rb_eRangeError;
+    break;
+  case SWIG_SyntaxError:
+    type = rb_eSyntaxError;
+    break;
+  case SWIG_ValueError:
+    type = rb_eArgError;
+    break;
+  case SWIG_SystemError:
+    type = rb_eFatal;
+    break;
+  case SWIG_AttributeError:
+    type = rb_eRuntimeError;
+    break;
+  case SWIG_NullReferenceError:
+    type = getNullReferenceError();
+    break;
+  case SWIG_ObjectPreviouslyDeletedError:
+    type = getObjectPreviouslyDeletedError();
+    break;
+  case SWIG_UnknownError:
+    type = rb_eRuntimeError;
+    break;
+  default:
+    type = rb_eRuntimeError;
+  }
+  return type;
+}
+
+
+/* This function is called when a user inputs a wrong argument to
+   a method.
+ */
+WXRB_EXPORT_FLAG
+const char* Ruby_Format_TypeError( const char* msg,
+				   const char* type,
+				   const char* name,
+				   const int argn,
+				   VALUE input )
+{
+  char buf[128];
+  VALUE str;
+  VALUE asStr;
+  if ( msg && *msg )
+  {
+    str = rb_str_new2(msg);
+  }
+  else
+  {
+    str = rb_str_new(NULL, 0);
+  }
+
+  str = rb_str_cat2( str, "Expected argument " );
+  sprintf( buf, "%d of type ", argn-1 );
+  str = rb_str_cat2( str, buf );
+  str = rb_str_cat2( str, type );
+  str = rb_str_cat2( str, ", but got " );
+  str = rb_str_cat2( str, rb_obj_classname(input) );
+  str = rb_str_cat2( str, " " );
+  asStr = rb_inspect(input);
+  if ( RSTRING_LEN(asStr) > 30 )
+  {
+    str = rb_str_cat( str, StringValuePtr(asStr), 30 );
+    str = rb_str_cat2( str, "..." );
+  }
+  else
+  {
+    str = rb_str_append( str, asStr );
+  }
+
+  if ( name )
+  {
+    str = rb_str_cat2( str, "\n\tin SWIG method '" );
+    str = rb_str_cat2( str, name );
+    str = rb_str_cat2( str, "'" );
+  }
+
+  return StringValuePtr( str );
+}
+
+/* This function is called when an overloaded method fails */
+WXRB_EXPORT_FLAG
+void Ruby_Format_OverloadedError(
+				 const int argc,
+				 const int maxargs,
+				 const char* method,
+				 const char* prototypes
+				 )
+{
+  const char* msg = "Wrong # of arguments";
+  if ( argc <= maxargs ) msg = "Wrong arguments";
+  rb_raise(rb_eArgError,"%s for overloaded method '%s'.\n"
+	   "Possible C/C++ prototypes are:\n%s",
+	   msg, method, prototypes);
+}