rs_232 2.3.2.pre → 3.0.0.pre2

data/ext/rs_232/{initializer.h → Rs232.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,43 +12,52 @@
  *
  **/
 
-#ifndef rs_232_initializer____FILEEXTENSION___
-#define rs_232_initializer____FILEEXTENSION___
-
-#if defined(WIN32) || defined(_WIN32) || defined(__WIN32) && !defined(__CYGWIN__)
+/*
+ * @author Roman Lishtaba
+ */
 
-#   include "windows/port.h"
+#pragma once
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+    
+#if defined(WIN32) || defined(_WIN32) || defined(__WIN32) && !defined(__CYGWIN__)
+    
+#   include "windows/Port.h"
+    
 #else
-
-#   include "posix/port.h"
-
+    
+#   include "posix/Port.h"
+    
 #endif
-
-#include "structs.h"
-
-VALUE initializeStruct(VALUE, VALUE);
-
-void updateSettings(PortDescriptor *port);
-
-VALUE isClosedIO(VALUE);
-
-VALUE openIO(VALUE);
-
-VALUE closeIO(VALUE);
-
-VALUE bytesAvailableIO(VALUE);
-
-VALUE flushIO(VALUE);
-
-VALUE writeIO(VALUE, VALUE);
-
-VALUE readIO(VALUE, VALUE);
-
-VALUE lineStatusIO(VALUE);
-
-VALUE setRtsIO(VALUE, VALUE);
-
-VALUE setDtrIO(VALUE, VALUE);
-
+    
+#include "Structs.h"
+    
+    VALUE initializeStruct(VALUE, VALUE);
+    
+    void updateSettings(PortDescriptor *port);
+    
+    VALUE isOpenIO(VALUE);
+    
+    VALUE openIO(VALUE);
+    
+    VALUE closeIO(VALUE);
+    
+    VALUE bytesAvailableIO(VALUE);
+    
+    VALUE flushIO(VALUE);
+    
+    VALUE writeIO(VALUE, VALUE);
+    
+    VALUE readIO(VALUE, VALUE);
+    
+    VALUE lineStatusIO(VALUE);
+    
+    VALUE setRtsIO(VALUE, VALUE);
+    
+    VALUE setDtrIO(VALUE, VALUE);
+    
+#ifdef __cplusplus
+}
 #endif

data/ext/rs_232/Structs.h

@@ -0,0 +1,63 @@
+/*
+ * 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.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+ * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
+ * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+ * PERFORMANCE OF THIS SOFTWARE.
+ *
+ **/
+
+/*
+ * @author Roman Lishtaba
+ */
+
+#pragma once
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+    
+#include "Constants.h"
+    
+    /*
+     * structure to contain port settings
+     */
+    typedef struct PortSettings_T
+    {
+        char              ComPort[40];
+        enum BaudRateType BaudRate;
+        enum DataBitsType DataBits;
+        enum ParityType   Parity;
+        enum StopBitsType StopBits;
+        enum FlowType     FlowControl;
+        long              Timeout_Millisec;
+    } PortSettings;
+    
+    
+    /*
+     * port descriptor structure
+     */
+    typedef struct portDescriptor_T
+    {
+#if defined(WIN32) || defined(_WIN32) || defined(__WIN32) && !defined(__CYGWIN__)
+        HANDLE       fd;
+        COMMCONFIG   commConfig;
+        COMMTIMEOUTS commTimeouts;
+#else
+        int            fd;
+        struct termios posixConfig;
+        struct termios previousPosixConfig;
+#endif
+        int          status;
+        PortSettings settings;
+        int          toBeUpdated;
+    } PortDescriptor;
+    
+#ifdef __cplusplus
+}
+#endif

data/ext/rs_232/extconf.rb

@@ -1,13 +1,16 @@
 require 'mkmf'
 require 'rbconfig'
 
-if ENV['DEBUG_C']
+EXTENSION_NAME = 'rs_232_native'.freeze
+dir_config(EXTENSION_NAME)
+
+if ENV['DEBUG']
   $CFLAGS << ' -DDEBUG'
-  $CFLAGS << ' -g -O'
+  $CFLAGS << ' -g'
   $stdout.puts "compiling in debug mode... flags: #{$CFLAGS}"
 end
 
-dir_config('rs_232')
+$CFLAGS << ' -Wall -g'
 
 $warnflags = '-Wall'
 
@@ -30,6 +33,7 @@ OS = case RbConfig::CONFIG['host_os'].downcase
 
 have_header('ruby.h')
 have_header('stdio.h')
+have_library( 'stdc++' )
 
 if OS == 'windows'
   $VPATH << '$(srcdir)/windows'
@@ -49,10 +53,10 @@ elsif %w(linux darwin).include? OS
   have_header('errno.h')
   have_header('sys/ioctl.h')
 else
-  fail "RS-233 implementation is not tested for this #{OS} platform."
+  fail "RS-233 implementation wasn't been tested for #{OS} platform."
 end
 
-$objs = %w(constants.o port.o initializer.o)
+$objs = %w(Constants.o Port.o Rs232.o).freeze
 
 $CFLAGS += " -DOS_#{OS.upcase}"
 
@@ -62,4 +66,4 @@ Extending with: #{$CFLAGS}
 
 MSG
 
-create_makefile('rs_232')
+create_makefile(EXTENSION_NAME)

data/ext/rs_232/posix/{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,66 +12,57 @@
  *
  **/
 
-#include "port.h"
+/*
+ * @author Roman Lishtaba
+ */
 
-VALUE setDtrIO(VALUE self, VALUE rb_int)
-{
-    {
-        Check_Type(rb_int, T_FIXNUM);
-    }
+#include "Port.h"
 
-    int boolean = FIX2INT(rb_int);
 
+VALUE setDtrIO(VALUE self, VALUE rb_int)
+{
+    Check_Type(rb_int, T_FIXNUM);
+    const int boolean = FIX2INT(rb_int);
+    int status;
     PortDescriptor *port = NULL;
-
     Data_Get_Struct(self, PortDescriptor, port);
-
-    int status;
+    
     ioctl(port->fd, TIOCMGET, &status);
     if (boolean == 1)
         status |= TIOCM_DTR;
     else
         status &= ~TIOCM_DTR;
     ioctl(port->fd, TIOCMSET, &status);
-
+    
     return INT2FIX(status);
-
 }
 
 
 VALUE setRtsIO(VALUE self, VALUE rb_int)
 {
-    {
-        Check_Type(rb_int, T_FIXNUM);
-    }
-
-    int boolean = FIX2INT(rb_int);
-
+    Check_Type(rb_int, T_FIXNUM);
+    const int boolean = FIX2INT(rb_int);
     PortDescriptor *port = NULL;
-
     Data_Get_Struct(self, PortDescriptor, port);
-
     int status;
+    
     ioctl(port->fd, TIOCMGET, &status);
     if (boolean == 1)
         status |= TIOCM_RTS;
     else
-        status &=
-                ~TIOCM_RTS;
+        status &= ~TIOCM_RTS;
     ioctl(port->fd, TIOCMSET, &status);
-
+    
     return INT2FIX(status);
 }
 
 
 VALUE lineStatusIO(VALUE self)
 {
-
     PortDescriptor *port = NULL;
-
     Data_Get_Struct(self, PortDescriptor, port);
-
     unsigned long Status = 0, Temp = 0;
+    
     ioctl(port->fd, TIOCMGET, &Temp);
     if (Temp & TIOCM_CTS) Status |= LS_CTS;
     if (Temp & TIOCM_DSR) Status |= LS_DSR;
@@ -81,7 +72,7 @@ VALUE lineStatusIO(VALUE self)
     if (Temp & TIOCM_RTS) Status |= LS_RTS;
     if (Temp & TIOCM_ST ) Status |= LS_ST;
     if (Temp & TIOCM_SR ) Status |= LS_SR;
-
+    
     return LONG2FIX(Status);
 }
 
@@ -89,7 +80,7 @@ VALUE lineStatusIO(VALUE self)
 static void platformInitIO(PortDescriptor *port)
 {
     port->fd     = -1;
-    port->status = 1;
+    port->status = PORT_CLOSED;
 }
 
 
@@ -107,19 +98,18 @@ static void setPosixBaudRate(PortDescriptor *port)
 
 void updateSettings(PortDescriptor *port)
 {
-
-    if (port->status != 0)
+    if (PORT_OPEN != port->status)
         rb_raise(rb_eException, "Can not set due to comport is not open, status: %d\n", port->status);
-
+    
     /*
-    * BaudRate clause ************************************************
-    */
+     * BaudRate clause
+     */
     if (port->toBeUpdated & T_BaudRate)
         setPosixBaudRate(port);
-
+    
     /*
-    * Parity clause ************************************************
-    */
+     * Parity clause
+     */
     if (port->toBeUpdated & T_Parity)
     {
         switch (port->settings.Parity)
@@ -136,11 +126,10 @@ void updateSettings(PortDescriptor *port)
                 break;
         }
     }
-
+    
     /*
-    * Data Bits clause ************************************************
-    */
-
+     * Data Bits clause
+     */
     if (port->toBeUpdated & T_DataBits)
     {
         port->posixConfig.c_cflag &= (~CSIZE);
@@ -160,11 +149,11 @@ void updateSettings(PortDescriptor *port)
                 break;
         }
     }
-
+    
     /*
-    * StopBits clause ************************************************
-    */
-
+     * StopBits clause
+     */
+    
     if (port->toBeUpdated & T_StopBits)
     {
         switch (port->settings.StopBits)
@@ -177,11 +166,11 @@ void updateSettings(PortDescriptor *port)
                 break;
         }
     }
-
+    
     /*
-    * FlowControl clause ************************************************
-    */
-
+     * FlowControl clause
+     */
+    
     if (port->toBeUpdated & T_Flow)
     {
         switch (port->settings.FlowControl)
@@ -201,25 +190,25 @@ void updateSettings(PortDescriptor *port)
                 break;
         }
     }
-
-
+    
+    
     /*
-    * In case of update flush IO
-    */
-
+     * In case of update flush IO
+     */
+    
     if (port->toBeUpdated & T_SettingsDone)
     {
         tcsetattr(port->fd, TCSAFLUSH, &port->posixConfig);
     }
-
+    
     /*
-    * Timeout clause ************************************************
-    */
-
+     * Timeout clause
+     */
+    
     if (port->toBeUpdated & T_TimeOut)
     {
         int timeout = port->settings.Timeout_Millisec;
-
+        
         if (timeout == -1)
         {
             fcntl(port->fd, F_SETFL, O_NDELAY); /* O_NDELAY should release if no any data here */
@@ -230,148 +219,116 @@ void updateSettings(PortDescriptor *port)
         }
         tcgetattr(port->fd, &port->posixConfig);
         port->posixConfig.c_cc[VTIME] = (timeout / 100);
-
+        
         tcsetattr(port->fd, TCSAFLUSH, &port->posixConfig);
     }
-
+    
     port->toBeUpdated = 0;
-
 }
 
 
 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) == 1 ? Qtrue : Qfalse;
+    return queryStatusIO(self) == PORT_OPEN ? Qtrue : Qfalse;
 }
 
 
 VALUE flushIO(VALUE self)
 {
     PortDescriptor *port = NULL;
-
     Data_Get_Struct(self, PortDescriptor, port);
-
+    
     return INT2FIX( tcdrain(port->fd) );
 }
 
 
 VALUE bytesAvailableIO(VALUE self)
 {
-
     PortDescriptor *port = NULL;
-
     Data_Get_Struct(self, PortDescriptor, port);
-
     int bytesQueued;
-
+    
     if (ioctl(port->fd, FIONREAD, &bytesQueued) == -1)
-    {
         return INT2FIX(0);
-    }
+    
     return INT2FIX(bytesQueued);
 }
 
 
 VALUE openIO(VALUE self)
 {
-
     PortDescriptor *port = NULL;
-
     Data_Get_Struct(self, PortDescriptor, port);
-
-    if ((port->fd = open(port->settings.ComPort, O_RDWR | O_NOCTTY | O_SYNC | O_NDELAY)) != -1)
+    
+    if ((port->fd = open(port->settings.ComPort, O_RDWR | O_NOCTTY | O_NDELAY)) != -1)
     {
-
-        port->status = 0;
-
-        {
-            rb_iv_set(self, "@open", INT2FIX(port->status));
-        }
-
+        port->status = PORT_OPEN;
+        rb_iv_set(self, "@open", INT2FIX(port->status));
+        
         tcgetattr(port->fd, &port->previousPosixConfig);
         port->posixConfig = port->previousPosixConfig;
         cfmakeraw(&port->posixConfig);
-
-
+        
         port->posixConfig.c_cflag |= CREAD | CLOCAL;
-        port->posixConfig.c_lflag &= (~(ICANON|ECHO|ECHOE|ECHOK|ECHONL|ISIG));
-        port->posixConfig.c_iflag &= (~(INPCK|IGNPAR|PARMRK|ISTRIP|ICRNL|IXANY));
+        port->posixConfig.c_lflag &= (~(ICANON| ECHO| ECHOE| ECHOK| ECHONL| ISIG));
+        port->posixConfig.c_iflag &= (~(INPCK| IGNPAR| PARMRK| ISTRIP| ICRNL| IXANY));
         port->posixConfig.c_oflag &= (~OPOST);
         port->posixConfig.c_cc[VMIN]  = 0;
         port->posixConfig.c_cc[VTIME] = 0;
-
+        
         port->toBeUpdated = T_ALL;
-
+        
         setSettings(self);
-
     } else
     {
-        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);
     }
-
-    return INT2FIX(port->status);
+    
+    return self;
 }
 
 
 VALUE writeIO(VALUE self, VALUE message)
 {
-
-    {
-        Check_Type(message, T_STRING);
-    }
-
-    int recv;
-    int len;
-
+    Check_Type(message, T_STRING);
     PortDescriptor *port = NULL;
-
     Data_Get_Struct(self, PortDescriptor, port);
-
-    len = (int) RSTRING_LEN(message);
+    
+    const int len = (int) RSTRING_LEN(message);
     char cStr[len];
     strcpy(cStr, RSTRING_PTR(message));
-
-    recv = (int) write(port->fd, cStr, (size_t) sizeof(cStr));
-
-    if (recv < 0){
+    
+    const int recv = (int) write(port->fd, cStr, (size_t) sizeof(cStr));
+    
+    if (recv < 0)
         rb_raise(rb_eEOFError, "TX: writing of the %d bytes has failed", len);
-    }
-
+    
     return INT2FIX(recv);
 }
 
 
 VALUE readIO(VALUE self, VALUE rb_int)
 {
-
-    {
-        Check_Type(rb_int, T_FIXNUM);
-    }
-
+    Check_Type(rb_int, T_FIXNUM);
     int recv;
-
     PortDescriptor *port = NULL;
-
     Data_Get_Struct(self, PortDescriptor, port);
-
-    int len = FIX2INT(rb_int);
-
+    const int len = FIX2INT(rb_int);
     char in[len];
-
+    
     recv = (int) read(port->fd, in, sizeof(in));
     if (recv > 0)
-       return rb_str_new(in, recv);
+        return rb_str_new(in, recv);
     
     return Qnil;
 }
@@ -379,51 +336,38 @@ VALUE readIO(VALUE self, VALUE rb_int)
 
 VALUE closeIO(VALUE self)
 {
-
-    int closed;
-
     PortDescriptor *port = NULL;
-
     Data_Get_Struct(self, PortDescriptor, port);
-
     flushIO(self);
-
     tcsetattr(port->fd, TCSAFLUSH | TCSANOW, &port->previousPosixConfig);
-    closed = close(port->fd);
-
-    port->status = closed == 0 ? 1 : 0;
-
+    
+    const int state = close(port->fd);
+    
+    port->status = (state == 0 ? PORT_CLOSED : PORT_OPEN);
+    
     rb_iv_set(self, "@open", INT2FIX(port->status));
     rb_iv_set(self, "@fd", INT2FIX(port->fd));
-
-    return INT2FIX(closed);
-
+    
+    return INT2FIX(state);
 }
 
 
 VALUE initializeStruct(VALUE self, VALUE portName)
 {
-
-    {
-        Check_Type(portName, T_STRING);
-    }
-
+    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;
-
+    
     strcpy(port->settings.ComPort, RSTRING_PTR(portName));
-
     platformInitIO(port);
-
     rb_iv_set(self, "@port", portName);
-
+    
     return self;
-}
+}