jfreeze-ruby-gdsii 1.0.1

data/CHANGELOG.txt

@@ -0,0 +1,6 @@
+= 1.0.1
+4 Dec 2008
+* Fixed naming bugs in commandline app help text
+
+= 1.0.0
+First general release

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Jim Freeze & Dan White
+Copyright (c) 2007 Intel Corporation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.txt

@@ -0,0 +1,113 @@
+
+=== Overview =================================================================
+
+The GDSII Ruby Library provides an easy-to-use interface using Ruby to reading
+and writing GDSII files.  Details may be found in the "doc" directory or by
+running "rdoc" on the "lib" directory.
+
+Contributors:
+
+ - Jim Freeze
+ - Ben Hoefer
+ - James Masters
+ - Matt Welland
+ - Dan White
+
+Project webspace:
+
+  http://rubyforge.org/projects/gdsii/
+
+This library is released under the MIT License (see LICENSE.txt)
+
+=== Installation =============================================================
+
+The "installation" is easy - simply add the contents in the "lib" directory
+in this package to a directory where Ruby is installed or set the $RUBYLIB
+environment variable to include the "lib" directory.
+
+
+=== Testing ==================================================================
+
+The GDSII library has been tested on Windows XP, SuSE Linux, SunOS, and HP-UX.
+To test the library on your own platform and configuration, a number of test
+suites are located in the "test" directory of this installation package:
+
+
+
+* test_gds_group.rb
+
+A unit test of the high-level GDSII methods.
+
+* test_gds_record.rb
+
+A unit test of the low-level GDSII methods.
+
+* h_pthru.rb
+
+Uses the GDSII high-level methods to read in a GDSII file and then write out
+the same GDSII file.  The file should be identical - or at least just have
+just EOF null-padding differences.
+
+* l_pthru.rb
+
+Uses the GDSII low-level methods to read in a GDSII file and then write out
+the same GDSII file.  The file should be identical - or at least just have
+just EOF null-padding differences.
+
+* h_write.rb
+
+Uses high-level GDSII methods to write out a number of GDSII records using
+many of the available method calls.  This can be useful to verify that the
+GDSII library is working and the output file can be compared against the
+file found in ./test/baseline/h_write.gds to ensure that the platform is
+reading and writing GDSII properly.
+
+
+=== Utility Scripts ==========================================================
+
+A few utility scripts have been included in the "bin" directory for general
+purpose use and/or for reference in using the Ruby GDSII library:
+
+* gds2rb
+
+Translates a GDSII file into a Ruby script containing commands to recreate the
+GDSII file. This might make custom edits to a GDSII file easy by post-
+processing the script through automation or by hand before running the script
+to produce an output GDSII file.
+
+* gdsdebug
+
+A detailed GDSII "dump" program that can be used to debug issues with a GDSII
+file that may be somehow corrupt or may be causing the GDSII Ruby file read
+methods to fail.
+
+* gdsdump
+
+A conversion of GDSII data to the "L" file format (ASCII). This can make
+quickly reviewing GDSII file contents through text very easy.
+
+* gdslayers
+
+Lists all layer and data types in the GDSII file.
+
+* gdssremove
+
+Removes the specified structure(s) from the GDSII file.
+
+* gdsssplit
+
+Extracts the specified structure(s) from the GDSII file and creates separate
+files for each of the extracted structures.
+
+* gdsstats
+
+Reads a GDSII file and produces a statistical summary of the contents of each
+structure in the file.
+
+* gdsstructs
+
+Lists all structure names found in the GDSII file.
+
+* gdstree
+
+Prints a hierarchical tree of structures in a GDSII file. 

data/Rakefile

@@ -0,0 +1,30 @@
+require 'rubygems'
+begin
+  require 'rake'
+rescue LoadError
+  puts 'This script should only be accessed via the "rake" command.'
+  puts 'Installation: gem install rake -y'
+  exit
+end
+
+require 'rake/testtask'
+require 'spec/rake/spectask'
+require 'fileutils'
+
+task :default => 'test'
+
+desc 'Run all tests'
+Rake::TestTask.new('test') do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/test_*.rb'
+  t.verbose = true
+end
+
+desc "RCov"
+Spec::Rake::SpecTask.new('rcov') do |t|
+  t.spec_opts = ["--format", "specdoc", "--colour"]
+  t.spec_files = Dir['test/test_*.rb'].sort
+  t.libs = ['lib' ]
+  t.rcov = true
+end
+

data/bin/rgds-debug

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+##############################################################################
+#
+# == gdsdebug.rb
+#
+# Reads a GDSII file and provides record-by-record details as the file is
+# read.  This is useful for debugging any GDSII read issues either by this
+# library or by another application.
+#
+# === Author
+#
+# James D. Masters (james.d.masters@gmail.com)
+#
+# === History
+#
+# * 03/26/2007 (jdm): Initial version
+#
+##############################################################################
+
+
+require 'gdsii/record.rb'
+include Gdsii
+
+# usage...
+if (file_name = ARGV[0]).nil? then
+  abort "
+Reads a GDSII file and provides record-by-record details as the file is read.
+This is useful for debugging any GDSII read issues either by this library or
+by another application.
+
+Usage: #{File.basename($PROGRAM_NAME)} <gds-file>
+
+"
+end
+
+# display the string representation for each record
+File.open(file_name, 'rb') do |file|
+  Record.read_debug = true
+  while (rec = Record.read(file)) do
+    # nothing additional required; debug messages will be printed
+  end
+end
+

data/bin/rgds-dump

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+##############################################################################
+#
+# == gdsdump.rb
+#
+# Dumps a GDSII file contents into a text-readable format.
+#
+# === Author
+#
+# James D. Masters (james.d.masters@gmail.com)
+#
+# === History
+#
+# * 03/26/2007 (jdm): Initial version
+#
+##############################################################################
+
+
+require 'gdsii/record.rb'
+include Gdsii
+
+# usage...
+if (file_name = ARGV[0]).nil? then
+  abort "
+Dumps a GDSII file contents into a text-readable format.
+
+Usage: #{File.basename($PROGRAM_NAME)} <gds-file>
+
+"
+end
+
+# display the string representation for each record
+File.open(file_name, 'rb') do |file|
+  while (rec = Record.read(file)) do
+    puts rec.to_s
+  end
+end
+

data/bin/rgds-join

@@ -0,0 +1,98 @@
+#!/usr/bin/env ruby
+##############################################################################
+#
+# == gdssjoin.rb
+#
+#
+# === Author
+#
+# James D. Masters (james.d.masters@gmail.com)
+#
+# === History
+#
+# * 04/04/2007 (jdm): Initial version
+#
+##############################################################################
+
+
+require 'getoptlong'
+require 'gdsii'
+include Gdsii
+
+# Build usage message
+usage = "
+Joins structures from multiple GDSII files into a new GDSII file.
+
+Usage: #{File.basename($PROGRAM_NAME)} [options] <new-gds-file> <other-gds-files...>
+
+Options:
+
+ -s, --structs      Specify structure(s) in a space separated list to join.
+ -f, --force        Force overwritting of new GDSII file if it already exists.
+ -h, --help         Displays this usage message.
+
+"
+
+# Get command-line arguments
+force = false
+structs = []
+
+opts = GetoptLong.new(
+  ['--structs',   '-s', GetoptLong::OPTIONAL_ARGUMENT],
+  ['--force',     '-f', GetoptLong::OPTIONAL_ARGUMENT|GetoptLong::NO_ARGUMENT],
+  ['--help',      '-h', GetoptLong::OPTIONAL_ARGUMENT|GetoptLong::NO_ARGUMENT]
+)
+
+opts.each do |option, argument|
+  case option
+  when '--help'      : abort usage
+  when '--structs'   : structs = argument.split(/\s+/)
+  when '--force'     : force = true
+  end
+end
+
+# Get GDSII file and output directory from command line
+new_gds_file, other_gds_files = ARGV[0], ARGV[1..-1]
+unless new_gds_file and other_gds_files
+  abort usage
+end
+
+# Check that output file does not exist (or force is set)
+if File.exists?(new_gds_file) and not force
+  abort "Output GDSII exists #{new_gds_file} use --force to overwrite"
+end
+
+# Open output GDSII file for write
+File.open(new_gds_file, 'wb') do |outf|
+
+  # Create library header
+  new_lib = Library.new('JOINED.DB')
+  new_lib.write_header(outf)
+  
+  # Loop through existing GDSII files and their structures; add to new
+  added_structs = {}
+  other_gds_files.each do |in_gds_file|
+    File.open(in_gds_file, 'rb') do |inf|
+      Library.read_header(inf)
+      Structure.read_each_header(inf) do |struct|
+        if added_structs[struct.name]
+          # already added; flag warning
+          warn "WARNING: Struct #{struct.name} in file #{in_gds_file} already added from file #{added_structs[struct.name]}; ignoring"
+        elsif structs.empty? or structs.member?(struct.name)
+          # no struct list given; or stuct on list
+          struct.write_header(outf)
+          Element.read_each(inf) {|element| element.write(outf)}
+          struct.write_footer(outf)
+          added_structs[struct.name] = in_gds_file
+        else
+          # not on provided list; skip this structure
+          Structure.seek_next(inf)        
+        end
+      end
+    end
+  end
+
+  # Create library footer
+  new_lib.write_footer(outf)
+  
+end

data/bin/rgds-layers

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+##############################################################################
+#
+# == gdslayers.rb
+#
+# Dumps a unique list of layers and their respective datatypes used in this
+# GDSII file.  Each layer/datatype pair is in the form 'LAYER DTYPE' with
+# a layer on each line.
+#
+# === Author
+#
+# James D. Masters (james.d.masters@gmail.com)
+#
+# === History
+#
+# * 03/26/2007 (jdm): Initial version
+#
+##############################################################################
+
+
+require 'getoptlong'
+require 'gdsii/record.rb'
+include Gdsii
+
+# Build usage message
+if (file_name = ARGV[0]).nil? then
+  abort "
+Dumps a unique list of layers and their respective datatypes used in this
+GDSII file.  Each layer/datatype pair is in the form 'LAYER DTYPE' with
+a layer on each line.
+
+Usage: #{File.basename($PROGRAM_NAME)} <gds-file>
+
+"
+end
+
+# Extract the layer numbers from the GDSII file
+listed = {}
+File.open(file_name, 'rb') do |file|
+  layer = nil
+  while (record = Record.read(file)) do
+    case record.type
+    when GRT_LAYER
+      layer = record.data_value
+    when GRT_DATATYPE, GRT_TEXTTYPE, GRT_NODETYPE, GRT_BOXTYPE
+      key = [layer, datatype = record.data_value]
+      puts "#{layer} #{datatype}" unless listed[key]
+      listed[key] = true
+    end
+  end
+end
+
+

data/bin/rgds-sremove

@@ -0,0 +1,136 @@
+#!/usr/bin/env ruby
+##############################################################################
+#
+# == gdssremove.rb
+#
+# Removes structures and/or structure references from a GDSII file.
+#
+# === Author
+#
+# James D. Masters (james.d.masters@gmail.com)
+#
+# === History
+#
+# * 03/26/2007 (jdm): Initial version
+#
+##############################################################################
+
+
+require 'getoptlong'
+require 'gdsii/record.rb'
+include Gdsii
+
+# Build usage message
+program = File.basename($PROGRAM_NAME)
+usage = "
+Removes structures and/or structure references from a GDSII file.
+
+Usage: #{File.basename($PROGRAM_NAME)} [options] -s <structs...> <in-gds-file> <out-gds-file>
+
+Options:
+
+ -s, --structs       Specify structure(s) in a space separated list to remove.
+ -f, --force         Force overwritting of the output GDSII file if it already
+                     exists.
+ -k, --keep-refs     Keeps SRef and ARef references (only removes structures).
+ -j, --keep-structs  Keeps structure definitions (only removes SRef and ARef).
+ -h, --help          Displays this usage message.
+
+Examples:
+
+ruby #{program} -s 'TOP SUB1' mydesign.gds outdesign.gds
+ruby #{program} -k -s 'SUB1'
+
+"
+
+# Get command-line arguments
+force = false
+structs = nil
+keep_refs = false
+keep_structs = false
+
+opts = GetoptLong.new(
+  ['--structs',      '-s', GetoptLong::REQUIRED_ARGUMENT],
+  ['--force',        '-f', GetoptLong::OPTIONAL_ARGUMENT|GetoptLong::NO_ARGUMENT],
+  ['--keep-refs',    '-k', GetoptLong::OPTIONAL_ARGUMENT|GetoptLong::NO_ARGUMENT],
+  ['--keep-structs', '-j', GetoptLong::OPTIONAL_ARGUMENT|GetoptLong::NO_ARGUMENT],
+  ['--help',         '-h', GetoptLong::OPTIONAL_ARGUMENT|GetoptLong::NO_ARGUMENT]
+)
+
+opts.each do |option, argument|
+  case option
+  when '--structs'      : structs = argument.split(/\s+/)
+  when '--force'        : force = true
+  when '--keep-refs'    : keep_refs = true
+  when '--keep-structs' : keep_structs = true
+  when '--help'         : abort usage
+  end
+end
+
+# Get GDSII file and output directory from command line
+in_gds, out_gds = ARGV
+unless in_gds and out_gds
+  abort usage
+end
+
+# Check to see if structs list was not set
+unless structs
+  abort "\nNo structures specified (-s or --structs)\n\n" + usage
+end
+
+# Check that GDSII file is readable
+unless File.readable? in_gds
+  abort "\nGDSII file does not exist or is not readable: #{in_gds}\n\n"
+end
+
+# Check to see if the output GDSII file already exists
+if File.exists? out_gds and not force
+  abort "\nOutput GDSII file exists: #{out_gds} (use -f or --force to override)\n\n"
+end
+
+
+# Read the GDSII file and write out resulting GDSII file
+File.open(in_gds, 'rb') do |inf|
+  File.open(out_gds, 'wb') do |outf|
+
+    # set r/w flags
+    remove_struct = false
+    remove_ref = false
+  
+    # Read each record in the GDSII file
+    Record.read_each(inf) do |record|
+      
+      case record.type
+      when GRT_BGNSTR
+        # read structure name and determine if this should be removed or not
+        if structs.member?(Record.peek(inf).data_value) and not keep_structs
+          remove_struct = true
+          next
+        end
+      when GRT_SREF, GRT_AREF
+        # read referenced name and determine if this should be removed or not
+        if structs.member?(Record.peek(inf).data_value) and not keep_refs
+          remove_ref = true
+          next
+        end
+      when GRT_ENDEL
+        # reset removal flag at the end of a reference definition
+        if remove_ref
+          remove_ref = false
+          next
+        end
+      when GRT_ENDSTR
+        # reset removal flag at the end of a structure definition
+        if remove_struct
+          remove_struct = false
+          next
+        end
+      end
+
+      # write the record if desired...
+      record.write(outf) unless remove_struct or remove_ref
+      
+    end
+    
+  end
+end