ruby-termios 0.9.6

data/ChangeLog

@@ -0,0 +1,146 @@
+2009-08-28  akira yamada  <akira@arika.org>
+
+	* version 0.9.6.
+
+2009-02-05  akira yamada  <akira@arika.org>
+
+	* termios.c: added RDoc.
+
+	* README: converted to RDoc.
+
+	* ruby-termios.gemspec: added.
+
+2008-10-23  akira yamada  <akira@arika.org>
+
+	* termios.c: added IOCTL_COMMANDS, IOCTL_COMMAND_NAMES,
+	  MODEM_SIGNALS, MODEM_SIGNAL_NAMES, PTY_PACKET_OPTIONS,
+	  PTY_PACKET_OPTION_NAMES, LINE_DISCIPLINES and
+	  LINE_DISCIPLINE_NAMES.
+	
+	  This change is contributed from Chris Hoffman
+	  <chrishoffman_cardialife.com>.
+
+	* termios.c, extconf.rb: included <sys/ioctl.h>.
+
+2008-06-03  akira yamada  <akira@arika.org>
+
+	* extconf.rb, termios.c: adjusted rb_io_t/OpenFile checks for Ruby
+	  1.8.7.
+
+2007-05-30  akira yamada  <akira@arika.org>
+
+	* extconf.rb: rb_io_t test isn't needed for Ruby 1.6.
+
+	* version 0.9.5.
+
+2007-05-29  Tanaka Akira  <akr@fsij.org>
+
+	* extconf.rb: check rb_io_t.
+	  check fd member in OpenFile.
+
+	* termios.c: support Ruby 1.9.
+	  use unsigned long for flags bigger than Fixnum such as CRTSCTS.
+	  use rb_sys_fail instead of rb_raise(rb_eRuntimeError).
+	  (Termios_to_termios): use rb_ary_entry to access cc_ary to avoid SEGV.
+	  (termios_tcgetpgrp): use pid_t.
+	  (termios_tcsetpgrp): ditto.
+	  (Termios::Termios#dup): defined to duplicate cc.
+	  (Termios::Termios#clone): ditto.
+	  (Termios::POSIX_VDISABLE): defined.
+	  (Termios::CCINDEX_NAMES): defined.
+	  (Termios::IFLAG_NAMES): defined.
+	  (Termios::OFLAG_NAMES): defined.
+	  (Termios::OFLAG_CHOICES): defined.
+	  (Termios::CFLAG_NAMES): defined.
+	  (Termios::CFLAG_CHOICES): defined.
+	  (Termios::LFLAG_NAMES): defined.
+	  (Termios::BAUD_NAMES): defined.
+	  (Termios::IUTF8): defined.
+	  (Termios::VDSUSP): defined for 4.4BSD.
+	  (Termios::VSTATUS): defined for 4.4BSD.
+	  (Termios::MDMBUF): defined for 4.4BSD.
+
+	* lib/termios.rb: new file.  inspect and pretty_print defined.
+	  
+2005-05-30  akira yamada  <akira@arika.org>
+
+	* termios.c: applied a patch which makes ruby-termios work under
+	  both ruby1.8 and ruby1.9.  [ruby-talk:143781]
+	  Thanks to: Akr.
+
+2002-10-13  akira yamada  <akira@arika.org>
+
+	* termios.c
+	(termios_set_ispeed): fixed typo.
+	(termios_initialize): 0-cleared "@cc".
+	(Termios_to_termios): unknown cc-values are treated as 0.
+
+	* examples/modem_check.rb: renamed examples/modem_check1.rb.
+
+	* examples/modem_check0.rb, exampes/modem_check2.rb: new.
+
+	* version 0.9.4.
+
+2002-10-12  akira yamada  <akira@arika.org>
+
+	* termios.c: revoked Termios::Termios#set_cc and removed some methods
+	such as Termios::Termios#iflag etc.  they became attr_reader.
+
+	* version 0.9.3.
+
+2002-10-12  akira yamada  <akira@arika.org>
+
+	* termios.c
+	(termios_cc): accepts index of c_cc.
+	(termios_set_a_cc): new function for Termios::Termios#set_cc.
+	(Init_termios): added new constants Termios::CCINDEX, Termios::IFLAGS,
+	Termios::OFLAGS, Termios::CFLAGS, Termios::LFLAGS and Termios::BAUD.
+
+	* examples/modem_check.rb: it did not work. rewrited.
+
+	* test/test0.rb: rewrited.
+
+	* version 0.9.2.
+
+2002-10-10  akira yamada  <akira@arika.org>
+
+	* termios.c
+	(Init_termios): revived Termios::Termios#c_foo/c_foo= for backward
+	compatibility.
+
+2002-09-25  akira yamada  <akira@arika.org>
+
+	* termios.c
+	(termios_clone): new method "clone" for Termios::Termios.
+	(Init_termios): revived Termios.new_termios for backward
+	compatibility.
+
+	* version 0.9.1.
+
+2002-09-25  akira yamada  <akira@arika.org>
+
+	* Termios module can be included to IO classes and can extend IO
+	objects.
+	
+	* now Termios::Termios is rb_cObject class.
+
+	* version 0.9.0.
+
+Wed Nov 15 19:03:06 2000  akira yamada  <akira@arika.org>
+
+	* renamed to ruby-termios.
+
+Wed Dec  1 21:27:23 1999  GOTO Kentaro <gotoken@math.sci.hokudai.ac.jp>
+
+	* termios.c: removed c_line.
+	* test1.rb: removed c_line.
+	* test3.rb: stty -echo.
+
+Fri Feb 19 00:05:20 1999  akira yamada  <akira@linux.or.jp>
+
+	* termios.c (Init_termios): now sTermios is hidden.
+	* test2.rb: rewrited.
+
+Fri Thu 18 02:24:21 1999  akira yamada  <akira@linux.or.jp>
+
+	* development started.

data/README

@@ -0,0 +1,80 @@
+= termios (ruby-termios) - a simple wrapper of termios(3)
+
+== Description
+
+This extension library provides Termios module.  It enables you to use
+termios(3) interface.
+
+Termios module is simple wrapper of termios(3).  It can be included into
+IO-family classes and can extend IO-family objects.  In addition, the
+methods can use as module function.
+
+== Requires
+
+This extension library can use with Ruby 1.6, 1.8 or 1.9. (Ruby-termios can
+build with Ruby 1.6 but it has not yet been tested enough.) 
+
+== Installation
+
+ ruby extconf.rb
+ make
+ make install
+
+== Copyright
+
+Ruby-termios for Ruby is copyrighted free software by akira yamada
+<akira@arika.org>.  You can redistribute it and/or modify it under either 
+the terms of the GPL, or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+	  with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under this terms.
+     They are gc.c(partly), utils.c(partly), regex.[ch], fnmatch.[ch],
+     glob.c, st.[ch] and some files under the ./missing directory.  See
+     each file for the copying condition.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/examples/modem_check0.rb

@@ -0,0 +1,69 @@
+require 'fcntl'
+require 'termios'
+include Termios
+
+DEVICE = '/dev/modem'
+BAUDRATE = B115200
+
+def dev_open(path)
+  dev = open(DEVICE, File::RDWR | File::NONBLOCK)
+  mode = dev.fcntl(Fcntl::F_GETFL, 0)
+  dev.fcntl(Fcntl::F_SETFL, mode & ~File::NONBLOCK)
+  dev
+end
+
+def dump_termios(tio, banner)
+  puts banner
+  puts "  ispeed = #{BAUDS[tio.ispeed]}, ospeed = #{BAUDS[tio.ospeed]}"
+  ["iflag", "oflag", "cflag", "lflag"].each do |x|
+    flag = tio.send(x)
+    flags = []
+    eval("#{x.upcase}S").each do |f, sym|
+      flags << sym.to_s if flag & f != 0
+    end
+    puts "   #{x} = #{flags.sort.join(' | ')}"
+  end
+  print "      cc ="
+  cc = tio.cc
+  cc.each_with_index do |x, idx|
+    print " #{CCINDEX[idx]}=#{x}" if CCINDEX.include?(idx)
+  end
+  puts
+end
+
+dev = dev_open(DEVICE)
+
+oldtio = getattr(dev)
+dump_termios(oldtio, "current tio:")
+
+newtio = new_termios()
+newtio.iflag = IGNPAR
+newtio.oflag = 0
+newtio.cflag = (CRTSCTS | CS8 | CREAD)
+newtio.lflag = 0
+newtio.cc[VTIME] = 0
+newtio.cc[VMIN] = 1
+newtio.ispeed = BAUDRATE
+newtio.ospeed = BAUDRATE
+dump_termios(newtio, "new tio:")
+
+flush(dev, TCIOFLUSH)
+setattr(dev, TCSANOW, newtio)
+dump_termios(getattr(dev), "current tio:")
+
+"AT\x0d".each_byte {|c|
+  c = c.chr
+  p [:write_char, c]
+  dev.putc c
+  d = dev.getc
+  p [:echo_back, d && d.chr || nil]
+}
+
+r = ''
+while /OK\x0d\x0a/o !~ r
+  r << dev.getc.chr
+  p [:response, r]
+end
+
+setattr(dev, TCSANOW, oldtio)
+dump_termios(getattr(dev), "current tio:")

data/examples/modem_check1.rb

@@ -0,0 +1,68 @@
+require 'fcntl'
+require 'termios'
+
+DEVICE = '/dev/modem'
+BAUDRATE = Termios::B115200
+
+def dev_open(path)
+  dev = open(DEVICE, File::RDWR | File::NONBLOCK)
+  mode = dev.fcntl(Fcntl::F_GETFL, 0)
+  dev.fcntl(Fcntl::F_SETFL, mode & ~File::NONBLOCK)
+  dev
+end
+
+def dump_termios(tio, banner)
+  puts banner
+  puts "  ispeed = #{Termios::BAUDS[tio.ispeed]}, ospeed = #{Termios::BAUDS[tio.ospeed]}"
+  ["iflag", "oflag", "cflag", "lflag"].each do |x|
+    flag = tio.send(x)
+    flags = []
+    eval("Termios::#{x.upcase}S").each do |f, sym|
+      flags << sym.to_s if flag & f != 0
+    end
+    puts "   #{x} = #{flags.sort.join(' | ')}"
+  end
+  print "      cc ="
+  cc = tio.cc
+  cc.each_with_index do |x, idx|
+    print " #{Termios::CCINDEX[idx]}=#{x}" if Termios::CCINDEX.include?(idx)
+  end
+  puts
+end
+
+dev = dev_open(DEVICE)
+
+oldtio = Termios::tcgetattr(dev)
+dump_termios(oldtio, "current tio:")
+
+newtio = Termios::new_termios()
+newtio.iflag = Termios::IGNPAR
+newtio.oflag = 0
+newtio.cflag = (Termios::CRTSCTS | Termios::CS8 | Termios::CREAD)
+newtio.lflag = 0
+newtio.cc[Termios::VTIME] = 0
+newtio.cc[Termios::VMIN] = 1
+newtio.ispeed = BAUDRATE
+newtio.ospeed = BAUDRATE
+dump_termios(newtio, "new tio:")
+
+Termios::tcflush(dev, Termios::TCIOFLUSH)
+Termios::tcsetattr(dev, Termios::TCSANOW, newtio)
+dump_termios(Termios::tcgetattr(dev), "current tio:")
+
+"AT\x0d".each_byte {|c|
+  c = c.chr
+  p [:write_char, c]
+  dev.putc c
+  d = dev.getc
+  p [:echo_back, d && d.chr || nil]
+}
+
+r = ''
+while /OK\x0d\x0a/o !~ r
+  r << dev.getc.chr
+  p [:response, r]
+end
+
+Termios::tcsetattr(dev, Termios::TCSANOW, oldtio)
+dump_termios(Termios::tcgetattr(dev), "current tio:")

data/examples/modem_check2.rb

@@ -0,0 +1,69 @@
+require 'fcntl'
+require 'termios'
+
+DEVICE = '/dev/modem'
+BAUDRATE = Termios::B115200
+
+def dev_open(path)
+  dev = open(DEVICE, File::RDWR | File::NONBLOCK)
+  mode = dev.fcntl(Fcntl::F_GETFL, 0)
+  dev.fcntl(Fcntl::F_SETFL, mode & ~File::NONBLOCK)
+  dev
+end
+
+def dump_termios(tio, banner)
+  puts banner
+  puts "  ispeed = #{Termios::BAUDS[tio.ispeed]}, ospeed = #{Termios::BAUDS[tio.ospeed]}"
+  ["iflag", "oflag", "cflag", "lflag"].each do |x|
+    flag = tio.send(x)
+    flags = []
+    eval("Termios::#{x.upcase}S").each do |f, sym|
+      flags << sym.to_s if flag & f != 0
+    end
+    puts "   #{x} = #{flags.sort.join(' | ')}"
+  end
+  print "      cc ="
+  cc = tio.cc
+  cc.each_with_index do |x, idx|
+    print " #{Termios::CCINDEX[idx]}=#{x}" if Termios::CCINDEX.include?(idx)
+  end
+  puts
+end
+
+dev = dev_open(DEVICE)
+dev.extend Termios
+
+oldtio = dev.tcgetattr
+dump_termios(oldtio, "current tio:")
+
+newtio = Termios::new_termios()
+newtio.iflag = Termios::IGNPAR
+newtio.oflag = 0
+newtio.cflag = (Termios::CRTSCTS | Termios::CS8 | Termios::CREAD)
+newtio.lflag = 0
+newtio.cc[Termios::VTIME] = 0
+newtio.cc[Termios::VMIN] = 1
+newtio.ispeed = BAUDRATE
+newtio.ospeed = BAUDRATE
+dump_termios(newtio, "new tio:")
+
+dev.tcflush(Termios::TCIOFLUSH)
+dev.tcsetattr(Termios::TCSANOW, newtio)
+dump_termios(dev.tcgetattr, "current tio:")
+
+"AT\x0d".each_byte {|c|
+  c = c.chr
+  p [:write_char, c]
+  dev.putc c
+  d = dev.getc
+  p [:echo_back, d && d.chr || nil]
+}
+
+r = ''
+while /OK\x0d\x0a/o !~ r
+  r << dev.getc.chr
+  p [:response, r]
+end
+
+dev.tcsetattr(Termios::TCSANOW, oldtio)
+dump_termios(dev.tcgetattr, "current tio:")

data/examples/secret_input1.rb

@@ -0,0 +1,12 @@
+# to input secretly [ruby-list:15968]
+require 'termios'
+
+oldt = Termios.tcgetattr($stdin)
+newt = oldt.dup
+newt.lflag &= ~Termios::ECHO
+Termios.tcsetattr($stdin, Termios::TCSANOW, newt)
+print "noecho> "
+a = $stdin.gets
+Termios.tcsetattr($stdin, Termios::TCSANOW, oldt)
+print "\n"
+p a