rs_232 2.3.2.pre → 3.0.0.pre2

data/ext/rs_232/posix/{port.h → Port.h}

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2013, Ingenico Inc.
+ * Copyright (c) 2013, Roman Lishtaba.
  *
  * Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted,
  * provided that the above copyright notice and this permission notice appear in all copies.
@@ -12,9 +12,16 @@
  *
  **/
 
-#ifndef rs_232_port_h____FILEEXTENSION___
-#define rs_232_port_h____FILEEXTENSION___
+/*
+ * @author Roman Lishtaba
+ */
+
+#pragma once
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+    
 #   include <ruby.h>
 #   include <stdio.h>
 #   include <string.h>
@@ -23,31 +30,33 @@
 #   include <errno.h>
 #   include <termios.h>
 #   include <sys/ioctl.h>
-#   include "structs.h"
-
-
-void setBaudRate(VALUE, VALUE);
-
-VALUE getBaudRate(VALUE);
-
-void setParity(VALUE, VALUE);
-
-VALUE getParity(VALUE);
-
-void setDataBits(VALUE, VALUE);
-
-VALUE getDataBits(VALUE);
-
-void setStopBits(VALUE, VALUE);
-
-VALUE getStopBits(VALUE);
-
-void setFlowControl(VALUE, VALUE);
-
-VALUE getFlowControl(VALUE);
-
-void setTimeout(VALUE, VALUE);
-
-void setSettings(VALUE);
-
+#   include "Structs.h"
+    
+    
+    void setBaudRate(VALUE, VALUE);
+    
+    VALUE getBaudRate(VALUE);
+    
+    void setParity(VALUE, VALUE);
+    
+    VALUE getParity(VALUE);
+    
+    void setDataBits(VALUE, VALUE);
+    
+    VALUE getDataBits(VALUE);
+    
+    void setStopBits(VALUE, VALUE);
+    
+    VALUE getStopBits(VALUE);
+    
+    void setFlowControl(VALUE, VALUE);
+    
+    VALUE getFlowControl(VALUE);
+    
+    void setTimeout(VALUE, VALUE);
+    
+    void setSettings(VALUE);
+    
+#ifdef __cplusplus
+}
 #endif

data/ext/rs_232/windows/{port.c → Port.c}

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2013, Ingenico Inc.
+ * Copyright (c) 2013, Roman Lishtaba.
  *
  * Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted,
  * provided that the above copyright notice and this permission notice appear in all copies.
@@ -12,7 +12,11 @@
  *
  **/
 
-#include "port.h"
+/*
+ * @author Roman Lishtaba
+ */
+
+#include "Port.h"
 
 
 VALUE setDtrIO(VALUE self, VALUE rb_int)
@@ -20,49 +24,44 @@ VALUE setDtrIO(VALUE self, VALUE rb_int)
     {
         Check_Type(rb_int, T_FIXNUM);
     }
-
     int boolean = FIX2INT(rb_int);
-
     PortDescriptor *port = NULL;
-
     Data_Get_Struct(self, PortDescriptor, port);
-
+    
     return INT2FIX( EscapeCommFunction(port->fd, boolean == 1 ? SETDTR : CLRDTR) );
 }
 
 
 VALUE setRtsIO(VALUE self, VALUE rb_int)
 {
-    {
-        Check_Type(rb_int, T_FIXNUM);
-    }
-
+    Check_Type(rb_int, T_FIXNUM);
+    
     int boolean = FIX2INT(rb_int);
-
+    
     PortDescriptor *port = NULL;
-
+    
     Data_Get_Struct(self, PortDescriptor, port);
-
+    
     return INT2FIX( EscapeCommFunction(port->fd, boolean == 1 ? SETRTS : CLRRTS) );
 }
 
 
 VALUE lineStatusIO(VALUE self)
 {
-
+    
     PortDescriptor *port = NULL;
-
+    
     Data_Get_Struct(self, PortDescriptor, port);
-
+    
     unsigned long Status = 0, Temp = 0;
-
+    
     GetCommModemStatus(port->fd, &Temp);
-
+    
     if (Temp & MS_CTS_ON) Status |= LS_CTS;
     if (Temp & MS_DSR_ON) Status |= LS_DSR;
     if (Temp & MS_RING_ON) Status |= LS_RI;
     if (Temp & MS_RLSD_ON) Status |= LS_DCD;
-
+    
     return LONG2FIX(Status);
 }
 
@@ -76,28 +75,28 @@ static void platformInitIO(PortDescriptor *port)
 
 void updateSettings(PortDescriptor *port)
 {
-
-    if (port->status != 0)
-        rb_raise(rb_eException, "Can not set due to comport is not open, status: %d\n", port->status);
-
-
+    
+    if (PORT_OPEN != port->status)
+        rb_raise(rb_eRuntimeError, "Can not set due to comport is not open, status: %d\n", port->status);
+    
+    
     if (port->toBeUpdated & T_BaudRate)
         port->commConfig.dcb.BaudRate = port->settings.BaudRate;
-
-
+    
+    
     if (port->toBeUpdated & T_Parity)
     {
         port->commConfig.dcb.Parity  = (BYTE) port->settings.Parity;
         port->commConfig.dcb.fParity = (port->settings.Parity == PAR_NONE) ? 0 : 1;
     }
-
-
+    
+    
     if (port->toBeUpdated & T_DataBits)
     {
         port->commConfig.dcb.ByteSize = (BYTE) port->settings.DataBits;
     }
-
-
+    
+    
     if (port->toBeUpdated & T_StopBits)
     {
         switch (port->settings.StopBits)
@@ -110,7 +109,7 @@ void updateSettings(PortDescriptor *port)
                 break;
         }
     }
-
+    
     if (port->toBeUpdated & T_Flow)
     {
         switch (port->settings.FlowControl)
@@ -135,11 +134,11 @@ void updateSettings(PortDescriptor *port)
                 break;
         }
     }
-
+    
     if (port->toBeUpdated & T_TimeOut)
     {
         int millisec                             = port->settings.Timeout_Millisec;
-
+        
         if (millisec == -1)
         {
             port->commTimeouts.ReadIntervalTimeout      = MAXDWORD;
@@ -153,14 +152,14 @@ void updateSettings(PortDescriptor *port)
         port->commTimeouts.WriteTotalTimeoutMultiplier = millisec;
         port->commTimeouts.WriteTotalTimeoutConstant   = 0;
     }
-
-
+    
+    
     if (port->toBeUpdated & T_SettingsDone)
         SetCommConfig(port->fd, &port->commConfig, sizeof(COMMCONFIG));
-
+    
     if ((port->toBeUpdated & T_TimeOut))
         SetCommTimeouts(port->fd, &port->commTimeouts);
-
+    
     port->toBeUpdated = 0;
 }
 
@@ -168,25 +167,25 @@ void updateSettings(PortDescriptor *port)
 static int queryStatusIO(VALUE self)
 {
     PortDescriptor *port = NULL;
-
+    
     Data_Get_Struct(self, PortDescriptor, port);
-
+    
     return port->status;
 }
 
 
-VALUE isClosedIO(VALUE self)
+VALUE isOpenIO(VALUE self)
 {
-    return queryStatusIO(self) != 0 ? Qtrue : Qfalse;
+    return queryStatusIO(self) != PORT_OPEN ? Qtrue : Qfalse;
 }
 
 
 VALUE flushIO(VALUE self)
 {
     PortDescriptor *port = NULL;
-
+    
     Data_Get_Struct(self, PortDescriptor, port);
-
+    
     return (INT2FIX(FlushFileBuffers(port->fd)));
 }
 
@@ -194,9 +193,9 @@ VALUE flushIO(VALUE self)
 VALUE bytesAvailableIO(VALUE self)
 {
     PortDescriptor *port = NULL;
-
+    
     Data_Get_Struct(self, PortDescriptor, port);
-
+    
     DWORD   Errors;
     COMSTAT Status;
     if (ClearCommError(port->fd, &Errors, &Status))
@@ -209,150 +208,148 @@ VALUE bytesAvailableIO(VALUE self)
 
 VALUE openIO(VALUE self)
 {
-
+    
     PortDescriptor *port = NULL;
-
     Data_Get_Struct(self, PortDescriptor, port);
-
-    if (port->status == 0)
-        return INT2FIX(port->status);
-
+    if (port->status == PORT_OPEN)
+        return self;
+    
     DWORD conf_length = sizeof(COMMCONFIG);
     port->commConfig.dwSize = conf_length;
     DWORD threading = 0;
-
+    
     port->fd = CreateFileA(port->settings.ComPort,
-            GENERIC_READ | GENERIC_WRITE,
-            0,
-            NULL,
-            OPEN_EXISTING,
-            threading,
-            NULL);
-
+                           GENERIC_READ | GENERIC_WRITE,
+                           0,
+                           NULL,
+                           OPEN_EXISTING,
+                           threading,
+                           NULL);
+    
     if (port->fd == INVALID_HANDLE_VALUE)
     {
-
-        port->status = 1;
-        rb_raise(rb_eException, "Unable to open comport: %s\n", port->settings.ComPort);
-
+        
+        port->status = PORT_CLOSED;
+        rb_raise(rb_eRuntimeError, "Unable to open comport: `%s`", port->settings.ComPort);
+        
     } else
     {
-
-        port->status = 0;
+        
+        port->status = PORT_OPEN;
         rb_iv_set(self, "@open", INT2FIX(port->status));
-
+        
         GetCommConfig(port->fd, &port->commConfig, &conf_length);
         GetCommState(port->fd, &(port->commConfig.dcb));
-
+        
         port->commConfig.dcb.fBinary       = 1;
         port->commConfig.dcb.fInX          = 0;
         port->commConfig.dcb.fOutX         = 0;
         port->commConfig.dcb.fAbortOnError = 0;
         port->commConfig.dcb.fNull         = 0;
-
+        
         port->commConfig.dcb.fDtrControl = 1;
-
+        
         port->toBeUpdated = T_ALL;
-
+        
         setSettings(self);
-
+        
     }
-
-    return INT2FIX(port->status);
+    
+    return self;
 }
 
 
 VALUE writeIO(VALUE self, VALUE message)
 {
-
+    
     int recv;
     int len;
     PortDescriptor *port = NULL;
-
+    
     Data_Get_Struct(self, PortDescriptor, port);
-
+    
     Check_Type(message, T_STRING);
-
+    
     len = RSTRING_LEN(message);
     char cStr[len];
     strcpy(cStr, RSTRING_PTR(message));
-
+    
     if (!WriteFile(port->fd, cStr, len, (LPDWORD)((void *) &recv), NULL))
     {
         rb_raise(rb_eIOError, "IO: writing of the %d bytes has been failed", len);
     }
-
+    
     return (INT2FIX(recv));
-
+    
 }
 
 
 VALUE readIO(VALUE self, VALUE rb_int)
 {
-
+    
     {
         Check_Type(rb_int, T_FIXNUM);
     }
-
+    
     PortDescriptor *port = NULL;
-
+    
     Data_Get_Struct(self, PortDescriptor, port);
-
+    
     int n;
     int len = FIX2INT(rb_int);
     char buf[len];
-
+    
     ReadFile(port->fd, &buf, len, (LPDWORD)((void *) &n), NULL);
-
+    
     if (n > 0)
-      return rb_str_new(buf, n);
-
+        return rb_str_new(buf, n);
+    
     return Qnil;
 }
 
 
 VALUE closeIO(VALUE self)
 {
-
+    
     PortDescriptor *port = NULL;
-
+    
     Data_Get_Struct(self, PortDescriptor, port);
-
+    
     flushIO(self);
     port->status = CloseHandle(port->fd);
     port->fd     = INVALID_HANDLE_VALUE;
-
+    
     rb_iv_set(self, "@open", INT2FIX(port->status));
-
+    
     return INT2FIX(port->status);
-
+    
 }
 
 
 VALUE initializeStruct(VALUE self, VALUE portName)
 {
-
+    
     {
         Check_Type(portName, T_STRING);
     }
-
+    
     PortDescriptor *port = NULL;
-
+    
     Data_Get_Struct(self, PortDescriptor, port);
-
+    
     port->settings.BaudRate         = BAUD115200;
     port->settings.Parity           = PAR_NONE;
     port->settings.FlowControl      = FLOW_OFF;
     port->settings.DataBits         = DATA_8;
     port->settings.StopBits         = STOP_1;
     port->settings.Timeout_Millisec = 0;
-
+    
     snprintf(port->settings.ComPort, sizeof(port->settings.ComPort) - 1, WIN_PATTERN, RSTRING_PTR(portName));
-
+    
     platformInitIO(port);
-
+    
     rb_iv_set(self, "@port", portName);
-
+    
     return self;
 }
 

data/ext/rs_232/windows/{port.h → Port.h}

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2013, Ingenico Inc.
+ * Copyright (c) 2013, Roman Lishtaba.
  *
  * Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted,
  * provided that the above copyright notice and this permission notice appear in all copies.
@@ -12,9 +12,16 @@
  *
  **/
 
-#ifndef rs_232_port_h____FILEEXTENSION___
-#define rs_232_port_h____FILEEXTENSION___
+/*
+ * @author Roman Lishtaba
+ */
+
+#pragma once
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+    
 #   include <ruby.h>
 #   include <ruby/io.h>
 #   include <windows.h>
@@ -22,32 +29,34 @@
 #   include <io.h>
 #   include <stdio.h>
 #   include <string.h>
-#   include "structs.h"
-
+#   include "Structs.h"
+    
 #define WIN_PATTERN "\\\\.\\%s"
-
-void setBaudRate(VALUE, VALUE);
-
-VALUE getBaudRate(VALUE);
-
-void setParity(VALUE, VALUE);
-
-VALUE getParity(VALUE);
-
-void setDataBits(VALUE, VALUE);
-
-VALUE getDataBits(VALUE);
-
-void setStopBits(VALUE, VALUE);
-
-VALUE getStopBits(VALUE);
-
-void setFlowControl(VALUE, VALUE);
-
-VALUE getFlowControl(VALUE);
-
-void setTimeout(VALUE, VALUE);
-
-void setSettings(VALUE);
-
+    
+    void setBaudRate(VALUE, VALUE);
+    
+    VALUE getBaudRate(VALUE);
+    
+    void setParity(VALUE, VALUE);
+    
+    VALUE getParity(VALUE);
+    
+    void setDataBits(VALUE, VALUE);
+    
+    VALUE getDataBits(VALUE);
+    
+    void setStopBits(VALUE, VALUE);
+    
+    VALUE getStopBits(VALUE);
+    
+    void setFlowControl(VALUE, VALUE);
+    
+    VALUE getFlowControl(VALUE);
+    
+    void setTimeout(VALUE, VALUE);
+    
+    void setSettings(VALUE);
+    
+#ifdef __cplusplus
+}
 #endif

data/lib/rs_232/version.rb

@@ -1,3 +1,3 @@
 module Rs232
-  VERSION = '2.3.2.pre'
+  VERSION = '3.0.0.pre2'.freeze
 end

data/lib/rs_232.rb

@@ -1,6 +1,98 @@
 require 'rs_232/version'
-require 'rs_232.so'
+require 'rs_232_native.so'
+require 'forwardable'
 
 module Rs232
-  # see 'examples' folder in order to use existent or decorate your own adapter.
+  # public accessible factory method
+  #
+  # @example
+  #
+  #   > port = Rs232.new('/dev/tty.ACM0', baud_rate: 9600)
+  #   #=> <#Rs232::Impl @port='/dev/tty.ACM0'>
+  #   > port.open?
+  #   #=> false
+  #   > port.connect
+  #   #=> <#Rs232::Impl @port='/dev/tty.ACM0'>
+  #   port.pending_bytes
+  #   #=> 15
+  #   port.read(15)
+  #   #=> 'Hello, World!!!'
+  #
+  def new_serial_port(port, opts = {}, &block)
+    Impl.new(port, opts, &block)
+  end
+
+  # the following class represents ruby public interface
+  # to native Rs232 implementation
+  #
+  # There no public instantiation, can be instantiate through
+  # the factory method @see Rs232.new
+  #
+  class Impl
+    include Rs232::Constants
+
+    STD_OPTS = {
+        baud_rate: BAUD_115200,
+        parity: PAR_NONE,
+        data_bits: DATA_BITS_8,
+        stop_bits: STOP_BITS_1,
+        flow_control: FLOW_OFF,
+        timeout: 10
+    }.freeze
+
+    extend Forwardable
+
+    def_delegators :@impl,
+                   :read,
+                   :write,
+                   :flush,
+                   :close,
+                   :open?,
+                   :set_rts,
+                   :set_dtr
+
+    def initialize(name, opts = {})
+      @impl = Rs232::Native.new(name)
+      @opts = STD_OPTS.merge(opts).freeze
+      freeze
+      yield self if block_given?
+    end
+
+    # @raise RuntimeError in case of open error
+    def connect
+      return self if open?
+      @impl.open.tap do |io|
+        io.baud_rate = @opts[:baud_rate]
+        io.parity = @opts[:parity]
+        io.data_bits = @opts[:data_bits]
+        io.stop_bits = @opts[:stop_bits]
+        io.flow_control = @opts[:flow_control]
+        io.timeout = @opts[:timeout]
+      end
+      self
+    end
+
+    def settings
+      {}.tap do |o|
+        o[:baud_rate] = @impl.baud_rate
+        o[:parity] = @impl.parity
+        o[:data_bits] = @impl.data_bits
+        o[:stop_bits] = @impl.stop_bits
+        o[:flow_control] = @impl.flow_control
+        o[:timeout] = @impl.timeout
+        o[:line_status] = @impl.line_status
+      end.freeze
+    end
+
+    def open?
+      @impl.open?
+    end
+
+    def close
+      return !open unless open?
+      0 == @impl.close
+    end
+  end
+
+  private_constant :Impl
 end