sicl 0.2.0 → 1.0.0

data/History.txt

@@ -1,8 +1,8 @@
-= 0.2.0 2007-05-12
-
-* add build rules for bcc32 with ruby-mswin32.
-* refactor testcases in test/test_sicl.rb.
-
-= 0.1.0 2007-05-12
-
-* Birthday!
+= 0.2.0 2007-05-12
+
+* add build rules for bcc32 with ruby-mswin32.
+* refactor testcases in test/test_sicl.rb.
+
+= 0.1.0 2007-05-12
+
+* Birthday!

data/Manifest.txt

@@ -1,9 +1,9 @@
-History.txt
-Manifest.txt
-README.txt
-Rakefile
-
-ext/sicl.c
-ext/extconf.rb
-ext/Makefile.bcc
-test/test_sicl.rb
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+
+ext/sicl.c
+ext/extconf.rb
+ext/Makefile.bcc
+test/test_sicl.rb

data/README.txt

@@ -1,79 +1,93 @@
-SICL/Ruby
-    http://rubyforge.org/projects/sicl/
-
-== DESCRIPTION:
-
-SICL/Ruby is SICL(Standard Instrument Control Library) API module for 
-Ruby. SICL is part of the Agilent IO Libraries Suite product. SICL/Ruby
-gives you a capability to control your instruments via GPIB, USB, and LAN.
-
-== SYNOPSIS:
-
-  require 'sicl'
-  
-  SICL.open('gpib0,17') do |io|
-    
-    io.output('*IDN?')
-
-    puts io.enter
-    
-    # ... instruments specific operations ...
-    
-  end
-
-or
-
-  require 'sicl'
-  
-  io = SICL.open('gpib0,17')
-  
-  io.output('*RST')
-
-  puts io.spoll
-
-  puts io.query('*IDN?')
-  
-  # ... instruments specific operations ...
-  
-  io.close
-
-or
-
-  require 'sicl'
-  
-  class MyInst < SICL::Instrument
-    def reset; output('*RST'); end
-  end
-  
-  io = MyInst.new 'gpib0,17'
-  
-  io.reset
-  
-  # ... instruments specific operations ...
-  
-  io.close
-
-== REQUIREMENTS:
-
-* Aiglent IO Libraries Suite 14.2
-
-Agilent Technologies
-    http://www.home.agilent.com
-
-== INSTALL:
-
-  $ export http_proxy='http://web-proxy:8088' # if you need
-  $ gem install sicl
-
-or
-
-  $ tar jvxf sicl.tar.bz2
-  $ cd sicl
-  $ ruby extconf.rb
-  $ make
-
-== LICENSE:
-
-(GPL ver.2)
-
-Copyright (c) 2007, Naoki Kobayashi
+= SICL/Ruby
+
+((<download|URL:http://rubyforge.org/projects/sicl/>))
+
+== DESCRIPTION:
+
+SICL/Ruby is SICL(Standard Instrument Control Library) API module for 
+Ruby. SICL is part of the Agilent IO Libraries Suite product. SICL/Ruby
+gives you a capability to control your instruments via GPIB, USB, and LAN.
+
+== SYNOPSIS:
+
+Please, use like this.
+
+Example:
+
+  require 'sicl'
+  
+  SICL.open('gpib0,17') do |io|
+    
+    io.output('*IDN?')
+
+    puts io.enter
+    
+    # ... instruments specific operations ...
+    
+  end
+
+or
+
+Example:
+
+  require 'sicl'
+  
+  io = SICL.open('gpib0,17')
+  
+  io.output('*RST')
+
+  puts io.spoll
+
+  puts io.query('*IDN?')
+  
+  # ... instruments specific operations ...
+  
+  io.close
+
+or
+
+Example:
+
+  require 'sicl'
+  
+  class MyInst < SICL::Instrument
+    def reset; output('*RST'); end
+  end
+  
+  io = MyInst.new 'gpib0,17'
+  
+  io.reset
+  
+  # ... instruments specific operations ...
+  
+  io.close
+
+== DOCUMENTS:
+
+SICL/Ruby Reference : ((<English|URL:sicl.en.html>))/((<Japanese|URL:sicl.ja.html>))
+
+== REQUIREMENTS:
+
+((<Aiglent IO Libraries Suite 14.2|URL:http://www.agilent.com/>))
+
+== INSTALL:
+
+If you can use the ((<RubyGems|URL:http://docs.rubygems.org/>)),
+Please install to use the ((|gem|)) command.
+
+  $ export http_proxy='http://web-proxy:8088' # if you need
+  $ gem install sicl
+
+Or not, Please build from the soruce code.
+
+  $ svn checkout svn://rubyforge.org/var/svn/sicl
+  $ cd sicl/ext
+  $ ruby extconf.rb
+  $ make
+  $ make install
+
+== LICENSE:
+
+(GPL ver.2)
+
+Copyright (c) 2007, Naoki Kobayashi

data/Rakefile

@@ -1,55 +1,78 @@
-################################################################################
-#
-#   Copyright (c) 2007 Naoki Kobayashi
-#
-#   This library is free software. ( except for SICL Library )
-#   You can distribute/modify this file under the same terms of ruby.
-#
-#   $Header: $
-#
-################################################################################
-
-begin
-  require 'rubygems'
-  require 'rake/gempackagetask'
-rescue Exception
-  nil
-end
-
-require "rake/clean"
-require "rake/gempackagetask"
-
-PKG_FILES = []
-File.open("Manifest.txt") do |manifest|
-  manifest.each do |file|
-    PKG_FILES << file.chomp if file =~ /\w+/
-  end
-end
-
-task :default => :package
-
-spec = Gem::Specification.new do |s|
-  s.name = "sicl"
-  s.version = "0.2.0"
-  s.summary = "Agilent SICL API wrapper class for Ruby."
-  s.autorequire = "sicl"
-  s.files = PKG_FILES
-  s.default_executable = "ext/extconf.rb"
-  s.extensions = ["ext/extconf.rb"]
-  s.description = <<EOF
-SICL/Ruby is SICL(Standard Instrument Control Library) API module for Ruby. SICL is part of the Agilent IO Libraries Suite product. SICL/Ruby gives you a capability to control your instruments via GPIB, USB, and LAN.
-EOF
-end
-
-Rake::GemPackageTask.new(spec) do |pkg|
-    pkg.need_tar_bz2 = true
-    pkg.need_tar_gz = true
-end
-
-task :test do
-  ruby "-Iext test/test_sicl.rb"
-end
-
-task :html do
-  sh "rd2 -r rd/rd2html-lib.rb --with-css=style.css doc/sicl.ja.rd > html/sicl.ja.html"
-end
+################################################################################
+#
+#   Copyright (c) 2007 Naoki Kobayashi
+#
+#   This library is free software. ( except for SICL Library )
+#   You can distribute/modify this file under the same terms of ruby.
+#
+#   $LastChangedDate$
+#   $Revision$
+#   $Author$
+#
+################################################################################
+
+begin
+  require 'rubygems'
+  require 'rake/gempackagetask'
+rescue Exception
+  nil
+end
+
+require "rake/clean"
+require "rake/gempackagetask"
+
+PKG_FILES = []
+File.open("Manifest.txt") do |manifest|
+  manifest.each do |file|
+    PKG_FILES << file.chomp if file =~ /\w+/
+  end
+end
+
+task :default => :package
+
+spec = Gem::Specification.new do |s|
+  s.name = "sicl"
+  s.version = "1.0.0"
+  s.summary = "Agilent SICL API wrapper class for Ruby."
+  s.autorequire = "sicl"
+  s.files = PKG_FILES
+  s.default_executable = "ext/extconf.rb"
+  s.extensions = ["ext/extconf.rb"]
+  s.description = <<EOF
+SICL/Ruby is SICL(Standard Instrument Control Library) API module for Rubby. SICL is part of the Agilent IO Libraries Suite product. SICL/Ruby gives you a capability to control your instruments via GPIB, USB, and LAN.
+EOF
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.need_tar_bz2 = true
+    pkg.need_tar_gz = true
+end
+
+task :test do
+  ruby "-Iext test/test_sicl.rb"
+end
+
+HTML_DIR = "html"
+CLEAN << HTML_DIR
+RD2_OPT = ["--out-code=euc-jp", "--with-css=style.css"]
+
+def convertToHtml(src, dst, title)
+  sh "rd2 -r rd/rd2html-lib.rb #{RD2_OPT.join(" ")} --html-title='#{title}' #{src} > #{dst}"
+end
+
+task :html do
+  Dir::mkdir HTML_DIR unless FileTest.exists? HTML_DIR
+
+  FileUtils.cp "doc/style.css", "html/style.css" 
+  [
+   ["README.txt", "html/index.html", "SICL/Ruby"],
+   ["doc/sicl.en.rd", "html/sicl.en.html", "SICL/Ruby Reference"],
+   ["doc/sicl.ja.rd", "html/sicl.ja.html", "SICL/Ruby Reference"]
+  ].each do |src, dst, title|
+    convertToHtml src, dst, title
+  end
+end
+
+task :www => :html do
+  sh "scp html/*.html html/*.css #{ENV['SVN_USER']}@sicl.rubyforge.org:/var/www/gforge-projects/sicl/"
+end

data/ext/Makefile.bcc

@@ -1,79 +1,81 @@
-################################################################################
-#
-#   Copyright (c) 2007 Satoshi Nihonyanagi
-#   Copyright (c) 2007 Naoki Kobayashi
-#
-#   $Header: $
-#
-#   Description: 
-#
-#        You need to export three environment variables for path of header
-#      files and libraries if you wish to build this library.
-#
-#          - SICL_DIR is path of Agilent IO Libraries Suite.
-#          - BCC_DIR is path of Borland C/C++ compiler.
-#          - RUBY_DIR is path of Ruby mswin32 verion.
-#
-#        Please, make like this:)
-#
-#        $ SICL_DIR='C:\Program Files\Agilent\IO Libraries Suite' \
-#        > BCC_DIR='C:\borland\bcc55' RUBY_DIR='C:\ruby-mswin32' \
-#        > PATH=/cygdrive/c/borland/bcc55/Bin:$PATH make -f Makefile.bcc
-#
-################################################################################
-
-################################################################################
-# Path definitions
-################################################################################
-
-#SICL_DIR     = C:\Program Files\Agilent\IO Libraries Suite
-SICL_INC_DIR = $(SICL_DIR)\include
-SICL_LIB_DIR = $(SICL_DIR)\lib
-
-#BCC_DIR      = C:\borland\bcc55
-BCC_INC_DIR  = $(BCC_DIR)\include
-BCC_LIB_DIR  = $(BCC_DIR)\lib
-
-#RUBY_DIR     = C:\ruby-mswin32
-RUBY_BIN_DIR = $(RUBY_DIR)\bin
-RUBY_INC_DIR = $(RUBY_DIR)\lib\ruby\1.8\i386-mswin32
-RUBYDLL      = msvcrt-ruby18.dll
-RUBYLIB      = $(RUBYDLL:.dll=.lib)
-
-################################################################################
-# Compiler and linker settings
-################################################################################
-
-CC       = bcc32
-CFLAGS   = -O2 -w-8070 -w-8004 -w-8057 \
-           -I"$(SICL_INC_DIR)" -I"$(RUBY_INC_DIR)" -I"$(BCC_INC_DIR)" \
-           -L"$(BCC_LIB_DIR)"
-
-LD       = ilink32
-LDFLAGS  = -L"$(BCC_LIB_DIR)" -L"$(SICL_LIB_DIR)"
-
-################################################################################
-# List of target files
-################################################################################
-
-SRCS     = sicl.c
-OBJS     = $(SRCS:.c=.obj)
-LIBS     = bcsicl32.lib import32.lib cw32mt.lib $(RUBYLIB)
-SICLDLL  = sicl.dll
-
-################################################################################
-# Build rules
-################################################################################
-
-.PHONY: all
-all: $(SICLDLL)
-
-$(RUBYLIB): $(RUBY_BIN_DIR)\$(RUBYDLL)
-	implib -a $@ $?
-
-$(SICLDLL): $(OBJS) $(RUBYLIB)
-	$(LD) $(LDFLAGS) -Tpd $? c0d32.obj, $(DLL), , $(LIBS),
-
-.PHONY: clean
-clean:
-	rm -f *~ *.obj *.lib *.tds *.map *.ilc *.ild *.ilf *.ils 
+################################################################################
+#
+#   Copyright (c) 2007 Satoshi Nihonyanagi
+#   Copyright (c) 2007 Naoki Kobayashi
+#
+#   $LastChangedDate$
+#   $Revision$
+#   $Author$
+#
+#   Description: 
+#
+#        You need to export three environment variables for path of header
+#      files and libraries if you wish to build this library.
+#
+#          - SICL_DIR is path of Agilent IO Libraries Suite.
+#          - BCC_DIR is path of Borland C/C++ compiler.
+#          - RUBY_DIR is path of Ruby mswin32 verion.
+#
+#        Please, make like this:)
+#
+#        $ SICL_DIR='C:\Program Files\Agilent\IO Libraries Suite' \
+#        > BCC_DIR='C:\borland\bcc55' RUBY_DIR='C:\ruby-mswin32' \
+#        > PATH=/cygdrive/c/borland/bcc55/Bin:$PATH make -f Makefile.bcc
+#
+################################################################################
+
+################################################################################
+# Path definitions
+################################################################################
+
+#SICL_DIR     = C:\Program Files\Agilent\IO Libraries Suite
+SICL_INC_DIR = $(SICL_DIR)\include
+SICL_LIB_DIR = $(SICL_DIR)\lib
+
+#BCC_DIR      = C:\borland\bcc55
+BCC_INC_DIR  = $(BCC_DIR)\include
+BCC_LIB_DIR  = $(BCC_DIR)\lib
+
+#RUBY_DIR     = C:\ruby-mswin32
+RUBY_BIN_DIR = $(RUBY_DIR)\bin
+RUBY_INC_DIR = $(RUBY_DIR)\lib\ruby\1.8\i386-mswin32
+RUBYDLL      = msvcrt-ruby18.dll
+RUBYLIB      = $(RUBYDLL:.dll=.lib)
+
+################################################################################
+# Compiler and linker settings
+################################################################################
+
+CC       = bcc32
+CFLAGS   = -O2 -w-8070 -w-8004 -w-8057 \
+           -I"$(SICL_INC_DIR)" -I"$(RUBY_INC_DIR)" -I"$(BCC_INC_DIR)" \
+           -L"$(BCC_LIB_DIR)"
+
+LD       = ilink32
+LDFLAGS  = -L"$(BCC_LIB_DIR)" -L"$(SICL_LIB_DIR)"
+
+################################################################################
+# List of target files
+################################################################################
+
+SRCS     = sicl.c
+OBJS     = $(SRCS:.c=.obj)
+LIBS     = bcsicl32.lib import32.lib cw32mt.lib $(RUBYLIB)
+SICLDLL  = sicl.dll
+
+################################################################################
+# Build rules
+################################################################################
+
+.PHONY: all
+all: $(SICLDLL)
+
+$(RUBYLIB): $(RUBY_BIN_DIR)\$(RUBYDLL)
+	implib -a $@ $?
+
+$(SICLDLL): $(OBJS) $(RUBYLIB)
+	$(LD) $(LDFLAGS) -Tpd $? c0d32.obj, $(DLL), , $(LIBS),
+
+.PHONY: clean
+clean:
+	rm -f *~ *.obj *.lib *.tds *.map *.ilc *.ild *.ilf *.ils